summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAge
* README.md: Explain where INSTALL.autoconf comes fromColin Watson2023-03-29
| | | | | | | Fixes https://gitlab.com/man-db/man-db/-/issues/16. * README.md: Explain that you may need to run `./bootstrap` to create `docs/INSTALL.autoconf`.
* Tweak README for better readabilityColin Watson2022-11-15
| | | | * README.md: Add blank line for improved Markdown rendering.
* Link to project home pageColin Watson2022-11-14
| | | | * README.md: Add home page link (https://man-db.gitlab.io/man-db/).
* Transfer Git repository to new groupColin Watson2022-11-14
| | | | | | | | | | * README.md, docs/HACKING.md, man/man1/apropos.man1, man/man1/lexgrog.man1, man/man1/man-recode.man1, man/man1/man.man1, man/man1/manconv.man1, man/man1/manpath.man1, man/man1/whatis.man1, man/man1/zsoelim.man1, man/man5/manpath.man5, man/man8/accessdb.man8, man/man8/catman.man8, man/man8/mandb.man8: Change GitLab URL to https://gitlab.com/man-db/man-db. * NEWS.md: Document this.
* Move compression file name utilities to lib/Colin Watson2022-09-23
| | | | | | | | | | | | | | | | | | | | | | | | This makes more sense as a home for plain file name manipulation utilities. I also merged `include/comp_src.h.in` into `lib/compression.c`, because structure definitions (as opposed to declarations) don't belong in header files. * src/compression.c: Move to ... * lib/compression.c: ... here. Remove unnecessary `pipeline.h` include. * src/compression.h: Move to ... * lib/compression.h: ... here. Update positioning of all includes. * lib/Makefile.am (libman_la_SOURCES): Add `compression.c` and `compression.h`. * lib/README: Add `compression.*`. * src/Makefile.am (lexgrog_SOURCES, man_SOURCES, man_recode_SOURCES, mandb_SOURCES): Remove `compression.c` and `compression.h`. * include/comp_src.h (comp_list): Move to ... * lib/compression.c (comp_list): ... here. Update all references. * include/manconfig.h (struct compression, comp_list): Move to ... * lib/compression.h (struct compression, comp_list): ... here. Add includes where necessary. * Makefile.am (noinst_HEADERS): Remove `include/comp_src.h`.
* Stop generating include/*.h from configureColin Watson2022-01-16
| | | | | | | | | | | | | | | | | This was inconvenient when making changes to those central header files. All `configure`-generated preprocessor symbols are now in `config.h`. * configure.ac: Define various PROG_* symbols. Remove AC_SUBST calls for compressors and decompressors. (AC_CONFIG_FILES): Remove include/comp_src.h and include/manconfig.h. * m4/man-arg-override-dir.m4: Define OVERRIDE_DIR symbol. * include/manconfig.h.in: Rename to ... * include/manconfig.h: ... this. Remove PROG_*, OVERRIDE_DIR, and COMPRESS_EXT definitions. * include/comp_src.h.in: Rename to ... * include/comp_src.h: ... this. * README.md: Update references to include/manconfig.h. * .gitignore: Remove include/*.h.
* Reformat release notes as MarkdownColin Watson2022-01-03
| | | | | | | | * NEWS: Move to ... * NEWS.md: ... here. Reformat as Markdown. * Makefile.am (dist_noinst_DATA): Remove NEWS; Automake automatically includes this file (or NEWS.md) in the distribution without help. * README.md, docs/HACKING: Refer to NEWS.md instead of NEWS.
* Simplify interface to container iterator macrosColin Watson2022-01-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The Gnulib container iterator macros (GL_LIST_FOREACH_* and GL_MAP_FOREACH_*) have to run code both before and after a chunk of user-supplied code. This previously required a START/END macro pair used something like this: GL_LIST_FOREACH_START (names, name) { ... } GL_LIST_FOREACH_END (names); This doesn't look natural in C, and so it was easy to get it wrong. It's possible to do better, at the cost of some tricky macros. Fortunately, Simon Tatham has already done the hard work in https://www.chiark.greenend.org.uk/~sgtatham/mp/, and the necessary header file is MIT-licensed, so we can incorporate it. Now these iterator macros are used more like this, which is a much more natural C style: GL_LIST_FOREACH (names, name) { ... } * lib/mp.h: New file. * lib/Makefile.am (libman_la_SOURCES): Add mp.h. * lib/README: Add mp.h. Rephrase introductory text about licensing to account for an MIT-licensed file. * lib/glcontainers.h (GL_LIST_FOREACH_START, GL_LIST_FOREACH_END): Rewrite as ... (GL_LIST_FOREACH): ... this. Update all callers. (GL_MAP_FOREACH_START, GL_MAP_FOREACH_END): Rewrite as ... (GL_MAP_FOREACH): ... this. Update all callers. * NEWS, README.md, docs/HACKING: Document C99 compiler requirement.
* Document migration to GitLabColin Watson2021-12-31
| | | | | | | | | | | | | | | | | | | * README.md: Add link to GitLab repository. (Contacting the maintainer): Add GitLab issues link. * docs/HACKING (Revision control): Update for GitLab. * man/man1/apropos.man1 (BUGS): Add GitLab issues link. * man/man1/lexgrog.man1 (BUGS): Likewise. * man/man1/man-recode.man1 (BUGS): Likewise. * man/man1/man.man1 (BUGS): Likewise. * man/man1/manconv.man1 (BUGS): Likewise. * man/man1/manpath.man1 (BUGS): Likewise. * man/man1/whatis.man1 (BUGS): Likewise. * man/man1/zsoelim.man1 (BUGS): Likewise. * man/man5/manpath.man5 (BUGS): Likewise. * man/man8/accessdb.man8 (BUGS): Likewise. * man/man8/catman.man8 (BUGS): Likewise. * man/man8/mandb.man8 (BUGS): Likewise. * NEWS: Document this.
* Reformat READMEColin Watson2021-11-17
* README: Move to ... * README.md: ... here. Reformat as Markdown. * Makefile.am (dist_noinst_DATA): Replace README with README.md. * docs/INSTALL.quick: Likewise.