]>
mj.ucw.cz Git - libucw.git/log
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.
Michal Vaner [Wed, 10 Sep 2008 11:14:30 +0000 (13:14 +0200)]
ucw. docs: update to use doc. system features
* Automatic formatting of NULL
* use `word` instead of +word+
* use <<links>> instead of xrefs
Michal Vaner [Wed, 10 Sep 2008 10:19:33 +0000 (12:19 +0200)]
UCW docs: split definitions off the main index
Michal Vaner [Wed, 10 Sep 2008 10:02:35 +0000 (12:02 +0200)]
Doc. system: fix function anchors
Only last character of their name was used to create the anchor.
Martin Mares [Tue, 9 Sep 2008 10:53:03 +0000 (12:53 +0200)]
Moved some utils from utils/ to ucw/
Some of the utilities do not need sherlock (and are not anyhow related
to it), so they were moved to libucw:
* b224 (base224 encoder/decoder)
* daemon-helper (replacement for start-stop-daemon)
* hex (hex dumper)
* rotate-log (log rotator)
* urltool (url manipulating tool)
Introduced a CONFIG_UCW_UTILS config switch which controls compilation
of these utilities.
Originally by Michal, with minor changes by MJ:
* basecode.test is added to TESTS only if CONFIG_UCW_UTILS is set.
* Changed the order of Makefile sections and Set statements to
a more logical one.
Martin Mares [Tue, 9 Sep 2008 10:32:43 +0000 (12:32 +0200)]
Doc. system: Hack around Makefile inexpressiveness.
Martin Mares [Tue, 9 Sep 2008 10:29:19 +0000 (12:29 +0200)]
Doc. system: Renamed doc utilities to match local conventions.
First, we do not use filename extensions for scripts which are not "compiled"
(e.g., the scripts that are a part of the build system).
Second, we prefer to build the naming hierarchy from the opposite end.
Martin Mares [Tue, 9 Sep 2008 10:26:10 +0000 (12:26 +0200)]
Doc. system: Make doc target messages more similar to the others.
Martin Mares [Tue, 9 Sep 2008 10:25:29 +0000 (12:25 +0200)]
Doc. system: Avoid ":=" rules in makefiles.
Martin Mares [Tue, 9 Sep 2008 09:25:42 +0000 (11:25 +0200)]
Fixed a typo: indeces -> indices.
Michal Vaner [Sun, 7 Sep 2008 15:21:56 +0000 (17:21 +0200)]
libucw documentation: index
Lists modules and definitions
Michal Vaner [Sun, 7 Sep 2008 15:17:15 +0000 (17:17 +0200)]
Doc. system: build rules for indeces and deflists
Michal Vaner [Sun, 7 Sep 2008 15:16:10 +0000 (17:16 +0200)]
Doc system: build system for deflists and indeces
Makefile rules for building documentation indeces
Michal Vaner [Sun, 7 Sep 2008 15:12:33 +0000 (17:12 +0200)]
Doc. system: dependencies bug
They should be appended, not overwritten, this would trash all previous
dependencies
Michal Vaner [Sun, 7 Sep 2008 15:08:04 +0000 (17:08 +0200)]
Doc. system: fix deflist asciidoc formatting
Collisions with automatic function references
Disallowed characters in captions which were needed
Michal Vaner [Sun, 7 Sep 2008 14:29:44 +0000 (16:29 +0200)]
Doc. system: definition list formatter
Michal Vaner [Sun, 7 Sep 2008 14:08:00 +0000 (16:08 +0200)]
Doc. system: links to files without anchors
<<filename:>> and <<filename:,caption>>
Michal Vaner [Sun, 7 Sep 2008 11:54:29 +0000 (13:54 +0200)]
Doc. system: file names with more chars allowed
Filenames in <<file:id>> referencies could not contain characters like
'/' or '.'. Now they can contain quite anything.
Michal Vaner [Sun, 7 Sep 2008 09:43:27 +0000 (11:43 +0200)]
Documentation system: teach extractor dump defs
If provided with another file name, it dumps all definitions with
filename, id number and text
Michal Vaner [Sat, 6 Sep 2008 11:44:00 +0000 (13:44 +0200)]
Documentation system: @word@ is not func. param.
So leave it as is
Michal Vaner [Fri, 5 Sep 2008 18:33:30 +0000 (20:33 +0200)]
Documentation: keep ; at the end of functions
And replace { at the end of inline functions with ;
Michal Vaner [Fri, 5 Sep 2008 18:18:53 +0000 (20:18 +0200)]
Add a description of extract-doc.pl script
Michal Vaner [Fri, 5 Sep 2008 18:14:35 +0000 (20:14 +0200)]
Documentation system: file xrefs
<<file:link>> and <<file:link,text>> links to other files work now.
Michal Vaner [Fri, 5 Sep 2008 17:55:28 +0000 (19:55 +0200)]
Documentation system: null-macro not needed
It is done by replacement, no need for a macro definition
Michal Vaner [Fri, 5 Sep 2008 17:48:56 +0000 (19:48 +0200)]
Documentation system: <<f()>> links
The <:f()> function links were replaced by ones more similar to existing
cross-reference links.
<<f(params)>> -- link to function
<<f(params),text>> -- with user-provided link text
<<file:f(params)>>,<<file:f(params),text>> -- link to a function in
different file
Furtheremore, the documentation config was split into backend specific
(xhtml at this moment only) and backend independent parts.
Martin Mares [Mon, 25 Aug 2008 21:28:33 +0000 (23:28 +0200)]
Doc: NULL is now detected and typeset properly.
Michal Vaner [Mon, 25 Aug 2008 20:53:13 +0000 (22:53 +0200)]
Less complicated syntax of function references
<file:function(params)>
<file:function(params):link text>
<:funciton(params)>
<:function(params):link text>
NULL detection (turned to be <tt>ed)
Martin Mares [Mon, 25 Aug 2008 21:24:25 +0000 (23:24 +0200)]
Configure: Fixed a bug in error handling.
Martin Mares [Mon, 25 Aug 2008 21:27:17 +0000 (23:27 +0200)]
Update documentation of fastbufs.
The back-ends should be fully covered now, the front-ends still remain
documented very sparsely.
Documentation of fb-atomic has been moved from the source to the header
file and asciidoc'ed.
I have also added a simple menu with links to all sections.
Michal Vaner [Mon, 25 Aug 2008 08:54:10 +0000 (10:54 +0200)]
Documentation system: manual function links
Things like this now works
>>f>:function(parameters)<<< - link to function in local file
>>f>:function(parameters):custom link text<<< - similar, named
>>f>file:function(parameters)<<< - into different file
>>f>file:function(parameters):custom text<<<
File is written without suffix (eg. no file.html, just file).
Michal Vaner [Mon, 18 Aug 2008 14:37:40 +0000 (16:37 +0200)]
Documentation system: generate anchors/ids for functions
When a function documentation is found, a fun_name_of_the_function
anchor (id html attribute) is added to it so links can jump there.
Michal Vaner [Mon, 18 Aug 2008 14:03:20 +0000 (16:03 +0200)]
Documentation system: detect functions by name()
Functions are detected, set in <tt> font and turned to links.
Michal Vaner [Sun, 3 Aug 2008 09:00:14 +0000 (11:00 +0200)]
Libucw: Documentation of more fastbuf headers.
Michal Vaner [Sat, 2 Aug 2008 19:44:18 +0000 (21:44 +0200)]
Libucw: documentation of fastbuf.h
Michal Vaner [Fri, 1 Aug 2008 16:52:20 +0000 (18:52 +0200)]
Documentation system: Structures are input verbatim.
Michal Vaner [Sun, 27 Jul 2008 11:32:30 +0000 (13:32 +0200)]
Enhanced documentation system.
Comments are now
/**
* Function comment.
**/
void function(void);
or void function(void); /** Function comment **/
/***
* Verbatim comment.
***/
or /*** Verbatim comment ***/
@param marks a function parameter.
It understands structures (to level 1, nested functions are flattened.
Is it needed?).
Michal Vaner [Sat, 26 Jul 2008 14:28:30 +0000 (16:28 +0200)]
Created documentation system.
`make docs' compiles documentation.
It uses asciidoc and is enriched by taking data directly from source code.
Some tests are done with ucw/doc/fastbuf.txt and ucw/fastbuf.h.
Created documentation is saved into the obj dir.
Martin Mares [Sun, 24 Aug 2008 18:31:59 +0000 (20:31 +0200)]
Fixed a comment.
Martin Mares [Wed, 30 Jul 2008 15:19:19 +0000 (17:19 +0200)]
Update MAX_WORD_xxx in the lib-only customization.
Martin Mares [Sun, 27 Jul 2008 18:42:02 +0000 (20:42 +0200)]
Build system: -soname should contain SONAME_SUFFIX.
Martin Mares [Sun, 27 Jul 2008 15:38:14 +0000 (17:38 +0200)]
Libucw: Cleaned up logging in fb-atomic.
Original patch by Michal, slightly changed by me.
Michal Vaner [Sun, 27 Jul 2008 12:22:10 +0000 (14:22 +0200)]
Libucw: Get rid of a warning during test.
(Unused argc)
Martin Mares [Sun, 27 Jul 2008 15:12:04 +0000 (17:12 +0200)]
Configure: Determine /var and related installation paths automatically.
Martin Mares [Sun, 27 Jul 2008 15:11:36 +0000 (17:11 +0200)]
Build: Let genconf expand variables recursively.
This is useful for example when filling in installation paths in configuration
files.
Martin Mares [Sun, 27 Jul 2008 12:59:47 +0000 (14:59 +0200)]
Configure: Avoid dashes in names of variables.