]>
mj.ucw.cz Git - libucw.git/log
Michal Vaner [Thu, 30 Oct 2008 23:38:43 +0000 (00:38 +0100)]
ucw docs: List of undocumented modules
Only first shot, still needs some sorting
Michal Vaner [Thu, 30 Oct 2008 14:35:21 +0000 (15:35 +0100)]
ucw docs: Mainloop
* May still need an example
* File descriptors need to be described
Michal Vaner [Thu, 30 Oct 2008 13:01:19 +0000 (14:01 +0100)]
ucw docs: Intro in index.html
Pavel Charvat [Thu, 30 Oct 2008 09:33:49 +0000 (10:33 +0100)]
Get rid of the "new" C++ keywords in ucwlib headers.
Pavel Charvat [Thu, 30 Oct 2008 09:20:57 +0000 (10:20 +0100)]
update_adler32 -> adler32_update (similar to {md5,sha1}_update)
Pavel Charvat [Thu, 30 Oct 2008 09:18:04 +0000 (10:18 +0100)]
default_thread_stack_size -> ucwlib_thread_stack_size
Pavel Charvat [Thu, 30 Oct 2008 09:14:30 +0000 (10:14 +0100)]
identify_protocol -> url_identify_protocol
Pavel Charvat [Wed, 29 Oct 2008 09:21:49 +0000 (10:21 +0100)]
Added missing ifdef guards to ucw/*.h.
Pavel Charvat [Mon, 27 Oct 2008 10:48:28 +0000 (11:48 +0100)]
Just renamed hash_block()'s `str' parameter to `buf'.
Pavel Charvat [Mon, 27 Oct 2008 10:44:31 +0000 (11:44 +0100)]
Fixed few typos.
Pavel Charvat [Mon, 27 Oct 2008 10:08:37 +0000 (11:08 +0100)]
Fixed a typo in configuration example.
Pavel Charvat [Mon, 27 Oct 2008 10:06:45 +0000 (11:06 +0100)]
Merge branch 'dev-lib' of ssh://git.ucw.cz/projects/sherlock/GIT/sherlock into dev-lib
Pavel Charvat [Mon, 27 Oct 2008 10:05:47 +0000 (11:05 +0100)]
short_opts[] should be chars, not bytes
Michal Vaner [Sun, 26 Oct 2008 19:10:21 +0000 (20:10 +0100)]
doc system: fix "struct name;"
It was considered as a variable.
Shortened the code a little bit on the way.
Pavel Charvat [Sun, 26 Oct 2008 18:03:03 +0000 (19:03 +0100)]
Improved the bbcopy()'s documentation once more :)
Pavel Charvat [Sun, 26 Oct 2008 18:00:06 +0000 (19:00 +0100)]
Slightly simplified bbcopy's documentation.
Pavel Charvat [Sun, 26 Oct 2008 17:51:56 +0000 (18:51 +0100)]
Documented the meaning of ~0U parameter in bbcopy().
Robert Spalek [Fri, 24 Oct 2008 07:32:40 +0000 (00:32 -0700)]
ucw/semaphore.h doesn't compile with gcc-4.0; the fix is trivial
Michal Vaner [Thu, 23 Oct 2008 08:45:13 +0000 (10:45 +0200)]
ucw docs: Operation names, link to config
Michal Vaner [Thu, 23 Oct 2008 08:37:28 +0000 (10:37 +0200)]
ucw docs: fix spacing in config.html
Michal Vaner [Thu, 23 Oct 2008 08:25:52 +0000 (10:25 +0200)]
ucw docs: parser units
Michal Vaner [Thu, 23 Oct 2008 08:15:00 +0000 (10:15 +0200)]
ucw docs: cf_pool
Pavel Charvat [Wed, 22 Oct 2008 12:52:33 +0000 (14:52 +0200)]
Implemented mp_restore_fast().
Pavel Charvat [Wed, 22 Oct 2008 12:50:39 +0000 (14:50 +0200)]
Assert that we called mp_printf_append() on a zero-terminated buffer.
Michal Vaner [Wed, 22 Oct 2008 12:43:55 +0000 (14:43 +0200)]
ucw docs: config.h -- journal & sections
Michal Vaner [Wed, 22 Oct 2008 12:03:42 +0000 (14:03 +0200)]
ucw docs: tweaks in conf.html
Michal Vaner [Wed, 22 Oct 2008 11:57:09 +0000 (13:57 +0200)]
ucw docs: CF_STRING and CF_LOOKUP types
Michal Vaner [Wed, 22 Oct 2008 11:43:54 +0000 (13:43 +0200)]
ucw docs: init and commit hooks described in-place
Michal Vaner [Wed, 22 Oct 2008 11:34:05 +0000 (13:34 +0200)]
ucw docs: multiple configuration items
arrays and lists of configuration items.
Martin Mares [Tue, 21 Oct 2008 10:17:04 +0000 (12:17 +0200)]
UCW doc: Fixed a typo.
Martin Mares [Tue, 21 Oct 2008 10:14:04 +0000 (12:14 +0200)]
UCW doc: minor fixes to the introduction to config parsing
Michal Vaner [Mon, 20 Oct 2008 21:39:47 +0000 (23:39 +0200)]
ucw docs: complete conf.h api documentation
The macros for describing configuration structure were not documented
yet.
Michal Vaner [Mon, 20 Oct 2008 20:34:21 +0000 (22:34 +0200)]
ucw docs: complete getopt api docs
Michal Vaner [Mon, 20 Oct 2008 20:28:21 +0000 (22:28 +0200)]
Doc. system: Fix one-line structs & enums
When a struct or enum started and ended on the same line
(eg. struct { som items; }), the extractor did not recognize it as an
end.
Michal Vaner [Mon, 20 Oct 2008 19:31:16 +0000 (21:31 +0200)]
ucw docs: factual error about custom parsers
The cf_journal_block is already called when the system calls the user
parser function, no need to call it again.
Michal Vaner [Mon, 20 Oct 2008 19:17:26 +0000 (21:17 +0200)]
ucw docs: tweaks in conf.txt
Michal Vaner [Sat, 18 Oct 2008 19:15:45 +0000 (21:15 +0200)]
ucw docs: Section about advanced uses of config
Describes custom parsers, reloading and hooks. Still some API
documentation needs to be done.
Michal Vaner [Tue, 7 Oct 2008 13:34:37 +0000 (15:34 +0200)]
ucw docs: Mempool examples
Added three examples of how a mempool can be used:
* string trie
* rollback an action which may fail
* loading whole stdin
Michal Vaner [Sat, 4 Oct 2008 14:14:55 +0000 (16:14 +0200)]
Doc. system: fix makefile, docs is phony target
Michal Vaner [Sat, 4 Oct 2008 13:32:19 +0000 (15:32 +0200)]
Doc. system: fix build in libsonly distribution
For some reason, the DOCDIR variable did not work in runtree generation,
had to move it above it.
Michal Vaner [Sat, 4 Oct 2008 12:48:52 +0000 (14:48 +0200)]
Doc. system: link docs under run directory
They are divided into modules, stored in run/doc/modulename. Only ucw
module exists now.
Michal Vaner [Fri, 3 Oct 2008 18:15:40 +0000 (20:15 +0200)]
ucw docs: Mempool struct internals are private
Tells the user not to dig inside.
Michal Vaner [Fri, 3 Oct 2008 18:07:31 +0000 (20:07 +0200)]
ucw docs: fix language error
Formatted has two "t"s.
Michal Vaner [Fri, 3 Oct 2008 18:04:56 +0000 (20:04 +0200)]
ucw docs: fix language error
Monospace, not monoscope
Martin Mares [Thu, 2 Oct 2008 14:30:38 +0000 (16:30 +0200)]
Renamed cf_write_item() to cf_modify_item().
The old name was somewhat counter-intuitive.
Martin Mares [Wed, 1 Oct 2008 18:05:55 +0000 (20:05 +0200)]
More play: Added indirect heapsort.
Martin Mares [Wed, 1 Oct 2008 17:51:16 +0000 (19:51 +0200)]
Just for fun: Added heapsort to the sorting benchmark.
Martin Mares [Wed, 1 Oct 2008 17:45:21 +0000 (19:45 +0200)]
Forgot to adapt retros.c to the new MD5 interface.
Michal Vaner [Wed, 1 Oct 2008 11:25:03 +0000 (13:25 +0200)]
Fix the fix of compilation
The LIKE_MALLOC flag should not be in the middle of return type.
Michal Vaner [Wed, 1 Oct 2008 08:25:39 +0000 (10:25 +0200)]
Fix compilation after writing docs
Michal Vaner [Wed, 1 Oct 2008 08:05:49 +0000 (10:05 +0200)]
TODO about documentation
Michal Vaner [Mon, 29 Sep 2008 09:50:20 +0000 (11:50 +0200)]
ucw docs: Documented mempools
There were many comments in the header file, reusing them,
adding only a little bit and reformatting.
Michal Vaner [Sun, 28 Sep 2008 13:43:36 +0000 (15:43 +0200)]
ucw docs: Some more in conf system
Documented something about loading the configuration by functions in
ucw/getopt.h.
Michal Vaner [Sun, 28 Sep 2008 13:42:43 +0000 (15:42 +0200)]
Doc. system: Properly extract multiline definitions
Michal Vaner [Sun, 28 Sep 2008 13:40:46 +0000 (15:40 +0200)]
Doc. system: escape apostrophes in def list
Asciidoc takes 'quoted' text as italic. Escape when part of the
definition.
Michal Vaner [Thu, 18 Sep 2008 20:53:16 +0000 (22:53 +0200)]
ucw docs: preprocess conf.h
Reused some comments in ucw/conf.h for documentation, created structure
in the file. Some things still need to be documented in this header
file.
Michal Vaner [Thu, 18 Sep 2008 20:46:46 +0000 (22:46 +0200)]
Doc. system: fix detection of pointer variables
The * before variable name stopped it from matching.
Michal Vaner [Thu, 18 Sep 2008 12:28:23 +0000 (14:28 +0200)]
Doc. system: detect function typedefs
things like
typedef function(void)
were considered functions, not types.
Michal Vaner [Thu, 18 Sep 2008 08:57:50 +0000 (10:57 +0200)]
Doc. system: stop pointer marks from boldifying
Sometimes two pointer asterisks in the definition made some part of it
bold, removing the asterisks. Escape them all.
Michal Vaner [Sun, 14 Sep 2008 16:03:00 +0000 (18:03 +0200)]
ucw docs: configuration parser (example)
Just an example how to use it. The thorough documentation of the headers
and functions to follow.
Michal Vaner [Sun, 14 Sep 2008 15:56:10 +0000 (17:56 +0200)]
Document the documentation system syntax
Maybe put it to a better place?
Michal Vaner [Sun, 14 Sep 2008 15:45:58 +0000 (17:45 +0200)]
Doc. system: add support for typedefs
And a little cleanup/code compression at the occasion.
Michal Vaner [Sun, 14 Sep 2008 14:02:00 +0000 (16:02 +0200)]
ucw docs: hashfunc reflects the syntax change
Michal Vaner [Sun, 14 Sep 2008 13:57:26 +0000 (15:57 +0200)]
ucw docs: basecode reflects the syntax change
Michal Vaner [Sun, 14 Sep 2008 13:52:06 +0000 (15:52 +0200)]
ucw docs: fastbufs reflect the syntax change
Change function() to @function() when a link should be created.
Michal Vaner [Sun, 14 Sep 2008 13:37:33 +0000 (15:37 +0200)]
Doc. system: use @function() for function links
<<function()>> works too, this is just replacement of the old implicit
function(), which caused problems (the system wanted to put the links
everywhere).
Removed some hacks around the old problems, which are no longer needed.
Michal Vaner [Sun, 14 Sep 2008 13:06:54 +0000 (15:06 +0200)]
ucw docs: fix function quoting
Michal Vaner [Sat, 13 Sep 2008 19:29:18 +0000 (21:29 +0200)]
Merge branch 'dev-lib' of ssh://git.ucw.cz/projects/sherlock/GIT/sherlock into dev-lib
Michal Vaner [Sat, 13 Sep 2008 19:28:50 +0000 (21:28 +0200)]
ucw. docs: Update hash documentation
More info about non-crypto hashes
Better links inside the page
Michal Vaner [Sat, 13 Sep 2008 18:12:51 +0000 (20:12 +0200)]
Doc. system: Fix inline functions in description
They had { }, if it was on the first line.
Simpler handling of definitions.
Michal Vaner [Sat, 13 Sep 2008 17:04:27 +0000 (19:04 +0200)]
Doc. system: deflists have different formatting
The asciidoc definition lists are used, the items are aligned in two
columns.
Martin Mares [Sat, 13 Sep 2008 15:23:21 +0000 (17:23 +0200)]
CGI.pm: More improvements to the cookie mechanism.
I am trying to make the parameters as close as possible to the
new standard (they make better sense and I want to keep the function
compatible with older versions of CGI.pm).
It also handles options with no values more gracefully.
Martin Mares [Sat, 13 Sep 2008 15:15:58 +0000 (17:15 +0200)]
CGI.pm: Cope with corrupted cookie headers.
Michal Vaner [Sat, 13 Sep 2008 12:21:52 +0000 (14:21 +0200)]
Doc. system: Add type sections to definition list
The definitions, grouped by type, have section captions (Enums, Structs,
etc).
Michal Vaner [Sat, 13 Sep 2008 12:11:42 +0000 (14:11 +0200)]
Doc. system: Definition list has visible name
The link is just the symbol name, the one-line header is bellow it now.
Michal Vaner [Sat, 13 Sep 2008 12:10:50 +0000 (14:10 +0200)]
Doc. system: fix semicolons
They were sometimes missing at the end of one-line headers.
Michal Vaner [Sat, 13 Sep 2008 11:44:56 +0000 (13:44 +0200)]
Doc. system: No body to func. header
Do not include body of inline functions even if the body is in the
single line.
Michal Vaner [Sat, 13 Sep 2008 11:36:32 +0000 (13:36 +0200)]
Doc. system: use better anchors
The anchor names are based on the name and type of identifier, not a
dull nothing telling number.
Michal Vaner [Sat, 13 Sep 2008 10:42:53 +0000 (12:42 +0200)]
Doc. system: fix ... in function parameters
Asciidoc tries to convert all ... strings into ellipsis character, which
is wrong in function parameters (it is 3 separate chars in reality,
besides this caused problems with xrefs, links, etc).
Michal Vaner [Sat, 13 Sep 2008 10:32:02 +0000 (12:32 +0200)]
Merge branch 'dev-lib' of ssh://git.ucw.cz/projects/sherlock/GIT/sherlock into dev-lib
Martin Mares [Sat, 13 Sep 2008 10:31:18 +0000 (12:31 +0200)]
CGI.pm: Make cookie setting headers backwards-compatible.
Michal Vaner [Sat, 13 Sep 2008 10:30:46 +0000 (12:30 +0200)]
Merge branch 'dev-lib' of ssh://git.ucw.cz/projects/sherlock/GIT/sherlock into dev-lib
Michal Vaner [Sat, 13 Sep 2008 10:30:01 +0000 (12:30 +0200)]
Doc. system: depend on build scripts
So when a script or configuration changes, all parts of documentation
are updated.
Martin Mares [Sat, 13 Sep 2008 10:28:53 +0000 (12:28 +0200)]
CGI.pm: Export URL and parameter de-escaping functions.
Michal Vaner [Sat, 13 Sep 2008 10:01:58 +0000 (12:01 +0200)]
ucw docs: more hash functions
I will add more when I find where they live
Martin Mares [Thu, 11 Sep 2008 21:18:29 +0000 (23:18 +0200)]
A couple of fixes to hash function documentation.
Michal Vaner [Thu, 11 Sep 2008 15:59:26 +0000 (17:59 +0200)]
Doc. system: recognize typedefs of structs
Recognize patterns like this as a struct. Similar for enum.
typedef struct {
something;
} name;
Michal Vaner [Thu, 11 Sep 2008 15:57:37 +0000 (17:57 +0200)]
ucw docs: Hash routines
MD5 and SHA1 hashes.
Michal Vaner [Thu, 11 Sep 2008 13:49:11 +0000 (15:49 +0200)]
ucw docs: update basecode
ASCII is only 7bits, this uses all 8.
Referencing a comment at the top of .c file.
Michal Vaner [Thu, 11 Sep 2008 12:32:10 +0000 (14:32 +0200)]
Doc. system: fix definition duplicities
They were caused by appending to a deflist instead of overwriting. If
the original file was changed and documentation recompiled, new
definitions were added to the old ones.
Michal Vaner [Thu, 11 Sep 2008 12:28:31 +0000 (14:28 +0200)]
ucw docs: base64 & base224
Documentation of base64 and base224 encoding. Describes the basecode
utility as well.
Michal Vaner [Wed, 10 Sep 2008 19:27:20 +0000 (21:27 +0200)]
Merge branch 'dev-lib' of ssh://git.ucw.cz/projects/sherlock/GIT/sherlock into dev-lib
Michal Vaner [Wed, 10 Sep 2008 19:25:13 +0000 (21:25 +0200)]
Doc. systems: definitions are grouped by type
They are grouped together by type. First are enums and structs, then
functions, then variables and preprocessor defines go last.
Michal Vaner [Wed, 10 Sep 2008 19:18:25 +0000 (21:18 +0200)]
Doc. system: typo in warn message
Michal Vaner [Wed, 10 Sep 2008 09:22:38 +0000 (11:22 +0200)]
b224 is deprecated by basecode
Michal Vaner [Wed, 10 Sep 2008 09:14:39 +0000 (11:14 +0200)]
Move ucw utils to subdirectory
Michal Vaner [Wed, 10 Sep 2008 19:05:01 +0000 (21:05 +0200)]
Doc. system: definitions are sorted
According to the symbol name.
Michal Vaner [Wed, 10 Sep 2008 18:58:47 +0000 (20:58 +0200)]
Doc. system: export type and name do deflists
Michal Vaner [Wed, 10 Sep 2008 18:54:39 +0000 (20:54 +0200)]
Doc. system: fix semicolon handling
No need for the hack in extracting loop, now put into formatting.
Fix the regexp in formatting part.
Michal Vaner [Wed, 10 Sep 2008 18:49:59 +0000 (20:49 +0200)]
Doc. system: detect type of definition
Just heuristics, detects type of the symbol and the name of the symbol.
It is used to add semicolon to inline functions what do not have one,
but more use of the detection is expected.