aniani/elinks
1
0
Fork 0
mirror of https://github.com/rkd77/elinks.git synced 2025-01-03 14:57:44 -05:00
Code

doc: Misc spelling and AsciiDoc compatibility fixes.

Browse Source 
This part of dev-intro.txt doesn't work on AsciiDoc 7.1.2:

.Overview of the hierarchy of the various subsystems. At the bottom are \
 subsystems that provide functionality used by the upper layers.

AsciiDoc treats only the first line as the title and includes the
backslash in the XHTML output.  It looks like the only way to fix
dev-intro.txt is to merge the lines into one, but this would both make
the source ugly and somehow generate "Example:" at the beginning of
the title.  Because doc/Makefile does not currently run AsciiDoc on
dev-intro.txt, I'm leaving this part unchanged.
This commit is contained in:
Kalle Olavi Niemitalo 2006-04-23 20:29:58 +03:00 committed by Kalle Olavi Niemitalo
parent 4161ed6e4e
commit ff3a1be247
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/dev-intro.txt
View File

@ -5,7 +5,7 @@ This is an introduction to how some of the internals of ELinks work. It
focuses on covering the basic low level subsystems and data structures and focuses on covering the basic low level subsystems and data structures and
give an overview of how things are glued together. Some additional information give an overview of how things are glued together. Some additional information
about ELinks internals are available in ELinks Hacking. Consult the README about ELinks internals are available in ELinks Hacking. Consult the README
file\cite{6} in the source directory to get an overview of how the different file in the source directory to get an overview of how the different
parts of ELinks depend on each other. parts of ELinks depend on each other.
@ -74,7 +74,7 @@ or initialised in an allocated data structure using the following:
When iterating a list, there are two looping macros: When iterating a list, there are two looping macros:
foreach (list-item, list-head}):: foreach (list-item, list-head)::
Iterates through all items in the list. Iterates through all items in the list.
@ -194,7 +194,7 @@ The `select()` loop regularly causes timer expiration to be checked. The
interface is defined in `src/main/timer.h` and can be used to schedule work to interface is defined in `src/main/timer.h` and can be used to schedule work to
be performed some time in the future. be performed some time in the future.
install_timer(timer-id, time-in-milliseconds, expiration-callback}, data):: install_timer(timer-id, time-in-milliseconds, expiration-callback, data)::
Starts a one shot timer bound to the given timer ID that will expire Starts a one shot timer bound to the given timer ID that will expire
after the given time in milliseconds. When the timer expires the after the given time in milliseconds. When the timer expires the
@ -213,7 +213,7 @@ using bottom halves. This is especially useful when nested deeply in some call
tree and one needs to cleanup some data structure but cannot do so immidately. tree and one needs to cleanup some data structure but cannot do so immidately.
The interface is defined in `src/main/select.h` The interface is defined in `src/main/select.h`
register_bottom_half(work-function, data}):: register_bottom_half(work-function, data)::
Schedules postponed work to be run and completed in the nearest Schedules postponed work to be run and completed in the nearest
future. Note that although this helps to improve the response time it future. Note that although this helps to improve the response time it
@ -225,10 +225,10 @@ Simple Threads
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
ELinks also supports a simple threading architecture. It is possible to start ELinks also supports a simple threading architecture. It is possible to start
a thread\footnote{(on UNIX systems this will end up using the `fork()` a thread footnote:[on UNIX systems this will end up using the `fork()`
system call} so that communication between it and the ELinks program is system call] so that communication between it and the ELinks program is
handled via a pipe. This pipe can then be used to pass to the handled via a pipe. This pipe can then be used to pass to the
`set_handlers()` function so that communcation is done asynchronously. `set_handlers()` function so that communication is done asynchronously.
start_thread(thread-function, thread-data, thread-data-length):: start_thread(thread-function, thread-data, thread-data-length)::
@ -261,14 +261,14 @@ make_connection(socket, uri, connect-callback, no-dns-cache)::
This function handles connecting to the host and port given in the uri This function handles connecting to the host and port given in the uri
argument. If the internal DNS cache is not to be used the argument. If the internal DNS cache is not to be used the
no-dns-cache} argument should be non-zero. Upon successful connection no-dns-cache argument should be non-zero. Upon successful connection
establishment the connect callback is called. establishment the connect callback is called.
read_from_socket(socket, read-buffer, connection-state, read-callback):: read_from_socket(socket, read-buffer, connection-state, read-callback)::
Reads data from socket into the given read buffer. Each time new data Reads data from socket into the given read buffer. Each time new data
is received the read callback is called. Changes the connection state is received the read callback is called. Changes the connection state
to connection-state} immediately after it has been called. to connection-state immediately after it has been called.
write_to_socket(socket, data, datalen, connection-state, write-callback):: write_to_socket(socket, data, datalen, connection-state, write-callback)::
@ -304,7 +304,7 @@ connection state. How the protocol back-end chooses to handle the connection
and load the URI it points to is entirely up to the back-end. The interface and load the URI it points to is entirely up to the back-end. The interface
is defined in `src/protocol/protocol.h` and `src/network/connection.h`. is defined in `src/protocol/protocol.h` and `src/network/connection.h`.
A connection can have multiple downloads attached to it. Each download struct} A connection can have multiple downloads attached to it. Each `download struct'
contains information about the connection state and the connection with which contains information about the connection state and the connection with which
it is attached. Additionally, the `download struct` specifies callback data, it is attached. Additionally, the `download struct` specifies callback data,
and a callback which is called each time the download progresses. The and a callback which is called each time the download progresses. The
@ -319,7 +319,7 @@ load_uri(uri, referrer, download, priority, cache-mode, offset)::
change_connection(old-download, new-download, new-priority, interrupt):: change_connection(old-download, new-download, new-priority, interrupt)::
Removes the old download from the connection it is attached to and add Removes the old download from the connection it is attached to and adds
the new download instead. If the new download argument is `NULL`, the the new download instead. If the new download argument is `NULL`, the
old download is simply stopped. old download is simply stopped.