Skip to content

Commit 524649c

Browse files
ARCHITECTURE.org: Update
1 parent 57a5edf commit 524649c

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

ARCHITECTURE.org

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ Copyright (C) Artyom V. Poptsov <poptsov.artyom@gmail.com>
88
notice and this notice are preserved.
99

1010
* Architecture
11-
The main goal of this project is to provide a Scheme interface to [[https://www.libssh.org/][libssh]]
12-
library which in turn implements SSH protocol (RFC 4250 and others.)
11+
The main goal of this project is to provide a [[https://www.gnu.org/software/guile/][GNU Guile]] (Scheme) interface to
12+
[[https://www.libssh.org/][libssh]] library which in turn implements [[https://en.wikipedia.org/wiki/Secure_Shell][SSH protocol]] (RFC 4250 and others.)
1313

1414
There are two main reasons that Guile-SSH uses libssh:
1515

1616
1. It was originally started as a wrapper to the libssh.
1717

1818
2. It's not easy to do the implementation of SSH protocol right; as it is the
1919
foundation for secure communication there's a great burden of maintaining
20-
the security of the code. =libssh= has comprehensive testing, is passed at
21-
least one [[https://www.libssh.org/2019/12/10/libssh-0-9-3-and-libssh-0-8-8-security-release/][security audit]] and it has many users.
20+
the security of the code. =libssh= has comprehensive testing, it is passed
21+
at least one [[https://www.libssh.org/2019/12/10/libssh-0-9-3-and-libssh-0-8-8-security-release/][security audit]] and it has many users.
2222

2323
In addition to the basic SSH client/server API (provided by libssh itself)
2424
Guile-SSH provides high-level procedures for operations over SSH channels.
@@ -38,7 +38,8 @@ Guile-SSH tries accomplish.
3838
Nevertheless public and stable C API might be advantageous in some situations
3939
like writing other low-level Scheme libraries or low-level Guile-SSH testing.
4040

41-
Each SMOB (Small Object) -- Scheme objects described in C -- is split in three files:
41+
Each SMOB (Small Object) -- a GNU Guile object described in C -- is split into
42+
three files:
4243
- =*-type.c= contains the implementation of a SMOB and some very basic
4344
procedures for it.
4445
- =*-func.c= contains the most of the procedures for working with that SMOB.

0 commit comments

Comments
 (0)