Second pass on fixing up documentation. Still some links not fixed.
This commit is contained in:
parent
a81b8b130a
commit
7b2deae88c
3
Doxyfile
3
Doxyfile
|
@ -790,7 +790,7 @@ WARN_LOGFILE = doxy.log
|
||||||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
||||||
# Note: If this tag is empty the current directory is searched.
|
# Note: If this tag is empty the current directory is searched.
|
||||||
|
|
||||||
INPUT = src docs
|
INPUT = src docs lisp
|
||||||
|
|
||||||
# This tag can be used to specify the character encoding of the source files
|
# This tag can be used to specify the character encoding of the source files
|
||||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
||||||
|
@ -817,6 +817,7 @@ INPUT_ENCODING = UTF-8
|
||||||
|
|
||||||
FILE_PATTERNS = *.c \
|
FILE_PATTERNS = *.c \
|
||||||
*.h \
|
*.h \
|
||||||
|
*.lisp \
|
||||||
*.markdown \
|
*.markdown \
|
||||||
*.md
|
*.md
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,8 @@
|
||||||
# Access control
|
# Access control
|
||||||
_
|
|
||||||
ote that a number of details not yet finalised are used in examples in this note. There must be some mechanism for creating fully qualified and partially qualified hierarchical names, but I haven't finalised it yet. In this note I've assumed that the portions of an hierarchical name are separated by periods ('.'); that fully qualified names start with a quote mark; and that where a name doesn't start with a quote mark, the first portion of it is evaluated in the current environment and its value assumed to be a fully qualified equivalent. All of these details may change._
|
*Not yet implemented*
|
||||||
|
|
||||||
|
_Note that a number of details not yet finalised are used in examples in this note. There must be some mechanism for creating fully qualified and partially qualified hierarchical names, but I haven't finalised it yet. In this note I've assumed that the portions of an hierarchical name are separated by periods ('.'); that fully qualified names start with a quote mark; and that where a name doesn't start with a quote mark, the first portion of it is evaluated in the current environment and its value assumed to be a fully qualified equivalent. All of these details may change._
|
||||||
|
|
||||||
In a multi-user environment, access control is necessary in order for a user to be able to protect an item of data from being seen by someone who isn't authorised to see it. But actually, in a world of immutable data, it's less necessary than you might think. As explained in my note on [Memory, threads and communication](https://www.journeyman.cc/blog/posts-output/2017-01-08-post-scarcity-memory-threads-and-communication/), if there's strict immutability, and all user processes spawn from a common root process, then no user can see into any other user's data space anyway.
|
In a multi-user environment, access control is necessary in order for a user to be able to protect an item of data from being seen by someone who isn't authorised to see it. But actually, in a world of immutable data, it's less necessary than you might think. As explained in my note on [Memory, threads and communication](https://www.journeyman.cc/blog/posts-output/2017-01-08-post-scarcity-memory-threads-and-communication/), if there's strict immutability, and all user processes spawn from a common root process, then no user can see into any other user's data space anyway.
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
# Cons space
|
# Cons space
|
||||||
|
|
||||||
|
*See [cons_space_object.h](consspaceobject_8h.html), [cons_page.h](conspage_8h.html).*
|
||||||
|
|
||||||
Cons space is a space which contains cons cells, and other objects whose memory representation fits into the footprint of a cons cell. A cons cell comprises:
|
Cons space is a space which contains cons cells, and other objects whose memory representation fits into the footprint of a cons cell. A cons cell comprises:
|
||||||
|
|
||||||
+-----+-------+------+----------------+--------------+--------------+
|
+-----+-------+------+----------------+--------------+--------------+
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
# Core functions
|
# Core functions
|
||||||
|
|
||||||
|
*See [ops/lispops.h](lispops_8h.html).*
|
||||||
|
|
||||||
In the specifications that follow, a word in all upper case refers to a tag value, defined on either the [cons space](Cons-space.html) or the [vector space](Vector-space.html) page.
|
In the specifications that follow, a word in all upper case refers to a tag value, defined on either the [cons space](Cons-space.html) or the [vector space](Vector-space.html) page.
|
||||||
|
|
||||||
# (and args...)
|
# (and args...)
|
||||||
|
@ -16,7 +18,7 @@ Public. Takes an arbitrary number of arguments, which should either all be CONS
|
||||||
|
|
||||||
# (assoc key store)
|
# (assoc key store)
|
||||||
|
|
||||||
Public. Takes two arguments, a key and a store. The store may either be a CONS forming the head of a list formatted as an [assoc list](Assoc-list.html), or else a VECP pointing to a HASH. If the key is readable by the current user, returns the value associated with that key in the store, if it exists and is readable by the current user, else NIL.
|
Public. Takes two arguments, a key and a store. The store may either be a CONS forming the head of a list formatted as an [assoc list](Hybrid-assoc-lists.html), or else a VECP pointing to a HASH. If the key is readable by the current user, returns the value associated with that key in the store, if it exists and is readable by the current user, else NIL.
|
||||||
|
|
||||||
# (car arg)
|
# (car arg)
|
||||||
|
|
||||||
|
|
14
src/io/history.c
Normal file
14
src/io/history.c
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
/*
|
||||||
|
* history.c
|
||||||
|
*
|
||||||
|
* Maintain, and recall, a history of things which have been read from standard
|
||||||
|
* input. Necessarily the history must be stored on the user session, and not be
|
||||||
|
* global.
|
||||||
|
*
|
||||||
|
* I *think* history will be maintained as a list of forms, not of strings, so
|
||||||
|
* only forms which have successfully been read can be recalled, and forms which
|
||||||
|
* have not been completed when the history function is invoked will be lost.
|
||||||
|
*
|
||||||
|
* (c) 2025 Simon Brooke <simon@journeyman.cc>
|
||||||
|
* Licensed under GPL version 2.0, or, at your option, any later version.
|
||||||
|
*/
|
14
src/io/history.h
Normal file
14
src/io/history.h
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
/*
|
||||||
|
* history.h
|
||||||
|
*
|
||||||
|
* Maintain, and recall, a history of things which have been read from standard
|
||||||
|
* input. Necessarily the history must be stored on the user session, and not be
|
||||||
|
* global.
|
||||||
|
*
|
||||||
|
* I *think* history will be maintained as a list of forms, not of strings, so
|
||||||
|
* only forms which have successfully been read can be recalled, and forms which
|
||||||
|
* have not been completed when the history function is invoked will be lost.
|
||||||
|
*
|
||||||
|
* (c) 2025 Simon Brooke <simon@journeyman.cc>
|
||||||
|
* Licensed under GPL version 2.0, or, at your option, any later version.
|
||||||
|
*/
|
Loading…
Reference in a new issue