[patch 2/2] doc: AsciiDoc, spelling, elinks.cz, and hacking.
Kalle Olavi Niemitalo <[email protected]>
| Newsgroups | gmane.comp.web.links |
|---|---|
| Message-ID | <[email protected]> |
I have set up a new branch at <http://www.iki.fi/kon/2006/elinks.git#plausible>. I intend to use it for changes that I think could be speedily merged to the development version <http://elinks.cz/elinks.git>. The sooner these are merged, the easier it will be to avoid merging in the opposite direction and keep the gitk display pretty, I think. I am also posting the changes to elinks-dev, in case you'd rather examine and apply them as patches than merge from my repository. (I asked for a merge on #elinks a few days ago, but AFAIK nothing happened.) The patch attached to this message is the second one in a set of two. It makes a number of minor changes to the documentation. _______________________________________________ elinks-dev mailing list [email protected] http://linuxfromscratch.org/mailman/listinfo/elinks-dev
(unnamed)
(text/x-patch, 12.1 KB)
doc: Misc spelling and AsciiDoc compatibility fixes. 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. --- commit ff3a1be24783ced5ac79d16d8c77c3d0e85db3ce tree a51a476482bfb6b51c60231dfe63facd0bfe5d5d parent 4161ed6e4e639f6641d32ac96476a99d609b516b author Kalle Olavi Niemitalo <[email protected]> Sun, 23 Apr 2006 20:29:58 +0300 committer Kalle Olavi Niemitalo <[email protected]> Sun, 23 Apr 2006 20:29:58 +0300 doc/dev-intro.txt | 22 +++++++++++----------- 1 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/dev-intro.txt b/doc/dev-intro.txt index 1fe648a..a1ad134 100644 --- a/doc/dev-intro.txt +++ b/doc/dev-intro.txt @@ -5,7 +5,7 @@ This is an introduction to how some of t focuses on covering the basic low level subsystems and data structures and give an overview of how things are glued together. Some additional information 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. @@ -74,7 +74,7 @@ or initialised in an allocated data stru 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. @@ -194,7 +194,7 @@ The `select()` loop regularly causes tim interface is defined in `src/main/timer.h` and can be used to schedule work to 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 after the given time in milliseconds. When the timer expires the @@ -213,7 +213,7 @@ using bottom halves. This is especially tree and one needs to cleanup some data structure but cannot do so immidately. 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 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 -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 +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 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):: @@ -261,14 +261,14 @@ make_connection(socket, uri, connect-cal 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 - 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. read_from_socket(socket, read-buffer, connection-state, read-callback):: Reads data from socket into the given read buffer. Each time new data 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):: @@ -304,7 +304,7 @@ connection state. How the protocol back- 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`. -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 it is attached. Additionally, the `download struct` specifies callback data, and a callback which is called each time the download progresses. The @@ -319,7 +319,7 @@ load_uri(uri, referrer, download, priori 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 old download is simply stopped. !-------------------------------------------------------------flip- doc: More AsciiDoc compatibility. --- commit c3f5c34dd3248da91b45eaf66ae5e49713780294 tree 2e391238adc6d36a12f97d3f01dcb3ce6a9c738d parent ff3a1be24783ced5ac79d16d8c77c3d0e85db3ce author Kalle Olavi Niemitalo <[email protected]> Thu, 27 Apr 2006 00:08:22 +0300 committer Kalle Olavi Niemitalo <[email protected]> Thu, 27 Apr 2006 00:08:22 +0300 doc/lua-scripting.txt | 11 +++++------ 1 files changed, 5 insertions(+), 6 deletions(-) diff --git a/doc/lua-scripting.txt b/doc/lua-scripting.txt index fc0f3e8..ae78ac7 100644 --- a/doc/lua-scripting.txt +++ b/doc/lua-scripting.txt @@ -100,7 +100,7 @@ You need to write some scripts. ELinks Lua additions ^^^^^^^^^^^^^^^^^^^^ -The Lua support is based on the idea of @dfn{hooks}. A hook is a function that +The Lua support is based on the idea of *hooks*. A hook is a function that gets called at a particular point during the execution of ELinks. To make ELinks do what you want, you can add and edit such hooks. @@ -180,14 +180,13 @@ standard Lua functions. enable_systems_functions ():: Enable some potentially dangerous functions, as well as some other functions which were unfortunate enough to be lumped in the same group. - ++ The functions are: `openfile`, `closefile`, `readfrom`, `writeto`, `appendto`, `pipe_read`, `remove`, `rename`, `flush`, `seek`, `tmpname`, `read`, `write` `execute`, `exit`, `clock`, `date`, `getenv`, `setlocale`. - ++ Note: `setlocale` is a standard Lua function and will not affect the current ELinks locale. -@end deffn current_url ():: Returns the URL of the current page being shown (in the ELinks session @@ -249,13 +248,13 @@ instead of copying code out of this docu covered here. If you would like to contribute scripts, that would be great! Please send -them to me at mailto:tjaden@@users.sourceforge.net[]. Cliff and I plan to +them to me at mailto:[email protected][]. Cliff and I plan to start a script repository, provided we get some contributions. As for script ideas, you'll just have to be a little creative :-) Also take a look at the `contrib/lua/` directory in the ELinks distribution. Note that Peter and Cliff don't maintain the Lua support intensively anymore, -thus it would be probably nice to Cc me (mailto:pasky@@ucw.cz[]) if you want +thus it would be probably nice to Cc me (mailto:[email protected][]) if you want to contribute some patch, so that I would be able to add it to the ELinks distribution. !-------------------------------------------------------------flip- doc: CVS is no longer used. Mention static accel checking. --- commit a19f271a8b06ae9949bd07c703f38be1246393e9 tree 8229889793f7abcde1fa1296a55701ebcfbc82e5 parent c3f5c34dd3248da91b45eaf66ae5e49713780294 author Kalle Olavi Niemitalo <[email protected]> Thu, 27 Apr 2006 00:09:23 +0300 committer Kalle Olavi Niemitalo <[email protected]> Thu, 27 Apr 2006 00:09:23 +0300 doc/hacking.txt | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/hacking.txt b/doc/hacking.txt index 367d516..7eb7ee8 100644 --- a/doc/hacking.txt +++ b/doc/hacking.txt @@ -502,7 +502,7 @@ All the .c files MUST start by a short o /* <short one-line description> */ -All the .h files MUST start by a CVS Id tag and then anti-reinclusion ifdef. +All the .h files MUST start by an anti-reinclusion ifdef. The macro is EL_<path_relative_to_src:s/[\/.]/_/>. @@ -682,7 +682,7 @@ which is why everybody concerned with EL In 0.5 versions `--enable-debug` add some fancy things: - many data integrity checking (see `lists.h`) - hotkey debugging: especially cool for translators, it highlights redundant - hotkeys in a menu. + hotkeys in a menu. (See also po/perl/check-accelerator-conflicts.pl.) - more errors messages - low bug tolerance: it will core dump on some errors instead of just writing an error description. !-------------------------------------------------------------flip- doc: Always refer to elinks.cz rather than elinks.or.cz. --- commit daaed3912bf5a168b16e1b6144119a88fef7c166 tree b5abde1f169253e6fc8fe0ac6d280ecc3458254d parent a19f271a8b06ae9949bd07c703f38be1246393e9 author Kalle Olavi Niemitalo <[email protected]> Thu, 27 Apr 2006 00:13:33 +0300 committer Kalle Olavi Niemitalo <[email protected]> Thu, 27 Apr 2006 00:13:33 +0300 doc/bookmarks.txt | 2 +- doc/elinks.1.txt | 4 ++-- doc/faq.txt | 2 +- doc/introduction.txt | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/bookmarks.txt b/doc/bookmarks.txt index b34357e..57f3d93 100644 --- a/doc/bookmarks.txt +++ b/doc/bookmarks.txt @@ -35,7 +35,7 @@ you will add them) and couple of buttons start, move with the right (or left; both will do) arrow to the button *Add bookmark* and fill in the input fields it offers to you. I mean, you can type something like "ELinks homepage" to the first field, then move down by e.g. -the down arrow and fill "http://elinks.or.cz/" to the second field. Then, +the down arrow and fill "http://elinks.cz/" to the second field. Then, bravely press enter and watch the bookmark popping up at the top of the vast area reserved for bookmarks. diff --git a/doc/elinks.1.txt b/doc/elinks.1.txt index 060336f..237176d 100644 --- a/doc/elinks.1.txt +++ b/doc/elinks.1.txt @@ -138,9 +138,9 @@ BUGS Please report any other bugs you find to the either the ELinks mailing list at mailto:[email protected][] or if you prefer enter them into -http://bugzilla.elinks.or.cz/[the bug tracking system]. More information about +http://bugzilla.elinks.cz/[the bug tracking system]. More information about how to get in contact with developers and getting help can be found on -http://elinks.or.cz/community.html[the community page]. +http://elinks.cz/community.html[the community page]. LICENSE ------- diff --git a/doc/faq.txt b/doc/faq.txt index 2aec057..4123bea 100644 --- a/doc/faq.txt +++ b/doc/faq.txt @@ -59,7 +59,7 @@ key-binding configuration) use Space to Why are there so many Links flavors? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Please refer to the link:http://elinks.or.cz/history.html[history page] to read +Please refer to the link:http://elinks.cz/history.html[history page] to read about the various flavors and the differences between them. diff --git a/doc/introduction.txt b/doc/introduction.txt index f185c79..df4f398 100644 --- a/doc/introduction.txt +++ b/doc/introduction.txt @@ -97,7 +97,7 @@ and buttons at the bottom. Below, a view +------------------------- Cookie manager -------------------------+ | | - | [-]- bugzilla.elinks.or.cz | + | [-]- bugzilla.elinks.cz | | | |-- BUGLIST | | | `-- LASTORDER | | [+]- kerneltrap.org |
signature.asc
(application/pgp-signature, 188 B)
-----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.2 (GNU/Linux) iD4DBQBEV4hqHm9IGt60eMgRAjz1AJdxqYeHfZCupKF3emAm5j6u6BVuAKCOtN7J Wa2P7hPaeSH0RTJeyIxBWw== =raA7 -----END PGP SIGNATURE-----