kc3-lang/pkgconf/man

Branch :


Log

Author Commit Date CI Message
7ba494a0 2025-09-05 12:33:55 man/pc.5: Add documentation for Source-tag to pc.5 man page Add more documentation to pc.5 man page to make sure that there is clear description how to use Source-tag
790ac897 2025-09-05 12:32:09 man/pkgconf.1: Small mention of Source-tag to pkgconf.1 man page Add similar mentioning of Source-tag than License-tag has to pkgconf.1 man page.
d3e94155 2025-06-03 19:44:28 man/pkgconf.1: mention that --list-all exits early
f0be161c 2025-06-03 19:27:38 man/pkgconf.1: mention that --atleast-pkgconfig-version exits early
509c34fa 2025-06-03 19:05:06 man/pkgconf.1: mention that PKG_CONFIG_SYSROOT_DIR sets pc_sysrootdir
8886d839 2025-06-03 19:03:27 man/pkgconf.1: describe DESTDIR more precisely
54019358 2025-06-03 16:56:50 man/pkgconf.1: document PKG_CONFIG_ALLOW_SYSTEM_{CFLAGS,LIBS}
efdeb71d 2025-06-04 21:09:13 man/pkgconf.1: improve the beginning of the DESCRIPTION Replace the first paragraph with an adequate description of what the program actually does, mention the main use case, and avoid vague wordings like "helps to" and "allow" and misleading wordings like "development libraries" (this is perfectly adequate for production builds, too) and "detect" (nothing is automatically detected, everything has to be specified explicitly in pc(5) configuration files). Add a second paragraph introducing the module search path because that concept is really crucial for the program. After that, add three paragraphs explaining the classification of options, in particular how they behave with respect to early exit and dependency resolution. Admittedly, this requires rather lengthy text, which is clearly undesirable at this place in a manual page. But the atrocious user interface design only leaves the choice of either bothering the reader with a long, complicated description, or not describing how the program behaves at all. Postponing the description of these interactions until after the option list would not be better. Understanding the classification up front helps to understand the descriptions and purposes of the individual options. What is still sorely missing is a precise definition of what the three different versions of the crucial term "dependency" mean, and how resolution actually works.
5729e1dd 2025-06-04 20:54:54 man/pkgconf.1: document --dump-personality --help --solution
11ea807f 2025-06-03 20:33:48 man/pkgconf.1: correctly describe the module version check options The options --atleast-version, --exact-version, and --max-version short-circuit to both success and failure, which implies that the result depends on the the order of the arguments and that a simple description is not possible. In particular, it is not possible to describe the behaviour with any sentence of the form "(succeed|fail) if (any|each) argument satisfies (condition)".
5c3b5b1d 2025-06-03 20:03:45 man/pkgconf.1: --log-file does not print to stdout
ac8cc800 2025-06-04 12:43:54 man: add bomtool manpage Closes: https://github.com/pkgconf/pkgconf/issues/408 Signed-off-by: Ariadne Conill <ariadne@ariadne.space>
5b02ec37 2025-06-04 11:59:05 man/pkgconf.1: document PKG_CONFIG_PRELOADED_FILES Signed-off-by: Ariadne Conill <ariadne@ariadne.space>
a61b00f1 2025-05-28 14:07:21 man/pkgconf.1: fix spelling of overridden
f2396064 2025-05-28 21:33:45 man/pkgconf.1: fix description of PKG_CONFIG_SYSROOT_DIR Fixes: ef59baf ("Document environment variables") Closes: https://github.com/pkgconf/pkgconf/issues/388 Signed-off-by: Ariadne Conill <ariadne@ariadne.space>
c34379ad 2025-05-18 21:03:33 man/pkgconf.1: better describe PKG_CONFIG_TOP_BUILD_DIR In particular, mention the default value and make it more explicit in which case the default is used.
c5953937 2025-05-18 20:08:30 man/pkgconf.1: better describe --print-variables and --variable In particular, mention that only the first "module" argument is used and clarify what exactly is printed.
adc54991 2025-05-18 19:26:24 man/pkgconf.1: rudimentary documentation of two more env vars Specifically, PKG_CONFIG_DONT_DEFINE_PREFIX and PKG_CONFIG_RELOCATE_PATHS.
e607da2e 2025-05-18 19:05:26 man/pkgconf.1: clarify the interaction of --static, --pure, and --shared
83c7ca08 2025-05-18 18:43:23 man/pkgconf.1: rudimentary documentation of PKG_CONFIG_IGNORE_CONFLICTS
5ad8a5be 2025-05-18 18:19:11 man/pkgconf.1: mention which options imply --print-errors
e785ee47 2025-05-18 17:52:32 man/pkgconf.1: fix incorrect description of PKG_CONFIG_DEBUG_SPEW It does *not* enable any additional debug logging, only --debug does that. This variable only overrides --silence-errors.
a7443fe5 2025-05-18 17:30:13 man/pkgconf.1: document PKG_CONFIG_MAXIMUM_TRAVERSE_DEPTH Also mention that it overrides --maximum-traverse-depth as well as which options override it.
cab9dcbf 2025-05-18 16:46:09 man/pkgconf.1: rudimentary documentation of --msvc-syntax Slightly improve the description of PKG_CONFIG_MSVC_SYNTAX, too.
4e7ecc37 2025-05-18 16:21:31 man/pkgconf.1: document some environment variables defining paths Document CPATH, C_INCLUDE_PATH, CPLUS_INCLUDE_PATH, OBJC_INCLUDE_PATH, and LIBRARY_PATH. Improve the description of PKG_CONFIG_SYSTEM_INCLUDE_PATH and PKG_CONFIG_SYSTEM_LIBRARY_PATH to mention their syntax, their default values, and what they actually do.
6546c4ba 2025-05-10 01:39:15 man/pkgconf.1: document four more command line options The options --about, --list-package-names, --short-errors, and --log-file were not documented yet. While documenting --log-file, adjust the description of PKG_CONFIG_LOG, too.
14d12281 2025-05-08 04:47:50 man/pkgconf.1: properly document the module search path Specifically, document --env-only, --list-all, --with-path, PKG_CONFIG_LIBDIR, and PKG_CONFIG_PATH, all of which were already mentioned, but very little was said about them, and much of what *was* said was outdated.
265a8a43 2025-05-07 03:25:29 man/pkgconf.1: two instances where .Va -> .Ar was forgotten
bd49b700 2025-05-07 03:15:33 man/pkgconf.1: sort the ENVIRONMENT section and use .Ev
d1a5b4f2 2025-05-07 02:40:23 man/pkgconf.1: correct the description of --path
31d73e40 2025-05-07 01:59:15 man/pkgconf.1: document --modversion and --verbose
bdede95f 2025-05-07 01:18:28 man/pkgconf.1: mark features not compiled in with PKGCONF_LITE
5123e180 2025-05-07 00:55:38 man/pkgconf.1: fix the markup of two instances of "module" They were erroneously marked up with .Cm instead of .Ar.
32cd9afb 2025-05-07 00:47:24 man/pkgconf.1: fix documentation bug regarding --*-version One single matching module is sufficient for success.
bd1b791a 2025-05-07 00:10:45 man/pkgconf.1: do not use all caps for the arguments of .Ar macros Very little text change, only minimal wording and markup improvements in the immediate vicinity.
e49ae602 2025-05-06 01:56:50 man/pkgconf.1: add the missing EXIT STATUS section
c3090718 2025-05-06 01:43:48 man/pkgconf.1: improve the description of --version
db4b0212 2025-05-06 01:27:53 man/pkgconf.1: improve the description of --print-requires
18332eff 2025-05-06 00:48:06 man/pkgconf.1: improve the description of --print-provides
2932604c 2025-05-05 23:29:16 man/pkgconf.1: improve the description of --exists
4c9afed4 2025-05-05 22:35:03 man/pkgconf.1: improve the description of --atleast-pkgconfig-version
50d0a3ae 2025-05-04 17:18:56 man/pkgconf.1: sort options list; no text or markup change
6414ec29 2025-05-04 02:17:27 man/pkgconf.1: better document --silence-errors, which was very incomplete
a1508c5f 2025-05-04 01:49:47 man/pkgconf.1: document --print-errors; it was missing
9e911529 2025-05-04 01:19:20 man/pkgconf.1: improve the description of --errors-to-stdout
71881ffe 2025-05-04 01:08:06 man/pkgconf.1: warning and debugging messages go to stderr Sorry for misreading the code earlier.
293cd1d5 2025-05-04 00:33:01 man/pkgconf.1: improve the description of --libs
210014a9 2025-05-03 23:56:03 man/pkgconf.1: document --debug, which was missing
4c2eaf5e 2025-05-03 22:36:05 man/pkgconf.1: improve the description of --cflags
d7bdb5e0 2025-05-03 21:08:00 man/pkgconf.1: use conventional syntax for the synopsis line
2d26db3a 2024-04-08 11:50:46 doc: Requires.private is used for header inclusion Document that "pkgconf --cflags" inherits paths for including headers from dependencies listed in Requires.private. https://github.com/pkgconf/pkgconf/issues/300 https://github.com/pkgconf/pkgconf/issues/352
27287f32 2022-12-30 17:52:10 Update sum value of types of property.
194ad3e6 2022-08-11 16:01:30 man: pc.5: document copyright/maintainer fields
b2579a66 2022-08-07 04:42:55 man: pc(5): document the License field
2fdc5f00 2021-03-29 07:15:30 man: Document the --validate option.
fd1b8ccc 2021-03-18 06:22:11 main: if PKG_CONFIG_FDO_SYSROOT_RULES is set, or DESTDIR matches PKG_CONFIG_SYSROOT_DIRS, disable the automatic sysroot rewriting Closes #205.
f9531ce9 2021-03-18 05:59:54 add support for pkgconf_cross_personality_t.want_default_pure
bd960e9d 2020-08-09 19:00:52 man: Silence pkgconf-personality.5 warning. man: ./pkgconf-personality.5:97:2: WARNING: unusual Xr order: pc(5) after pkg.m4(7)
262a0c96 2020-06-03 21:50:27 man: pkgconf: fixed typo Fixed typo in it's vs its.
fce1199b 2020-05-24 14:34:17 cli: add support for PKG_CONFIG_MSVC_SYNTAX env variable Patch from Dan Kegel.
48dc665a 2019-10-19 00:56:17 personality: add support for WantDefaultStatic setting
40fe4835 2019-10-19 00:45:49 cli: main: add --shared option
f1ce3936 2019-09-30 05:22:21 fix pkgconf-personality man page
1d8c6b71 2019-07-12 16:50:51 Fix troff markup in pkgconf-personality(5) A list was started with .Bl but not ended (with .El)
db3ba0ef 2019-07-12 16:50:50 Fix spelling in pkg.m4(7)
0a247fa1 2019-07-11 03:42:37 man: pkgconf: add --modversion description (closes #34)
41f80315 2018-07-19 17:25:28 man: add pkgconf-personality(5)
4704b932 2018-04-09 21:43:47 man: Silence mandoc warnings for pkg.m4.7 man -Tlint pkg.m4 new sentence, new line (mdoc) A new sentence starts in the middle of a text line. Start it on a new input line to help formatters produce correct spacing. skipping paragraph macro In mdoc(7) documents, this happens - at the beginning and end of sections and subsections - right before non-compact lists and displays - at the end of items in non-column, non-compact lists - and for multiple consecutive paragraph macros. In man(7) documents, it happens - for empty P, PP, and LP macros - for IP macros having neither head nor body arguments - for br or sp right after SH or SS no blank before trailing delimiter (mdoc) The last argument of a macro that supports trailing delimiter arguments is longer than one byte and ends with a trailing delimiter. Consider inserting a blank such that the delimiter becomes a separate argument, thus moving it out of the scope of the macro. man: pkg.m4.7:30:34: WARNING: new sentence, new line man: pkg.m4.7:38:20: WARNING: new sentence, new line man: pkg.m4.7:33:2: WARNING: skipping paragraph macro: Pp after Sh man: pkg.m4.7:41:2: WARNING: skipping paragraph macro: Pp at the end of Ss man: pkg.m4.7:46:2: WARNING: skipping paragraph macro: Pp at the end of Ss man: pkg.m4.7:134:27: STYLE: no blank before trailing delimiter: Nm ... check. man: pkg.m4.7:143:27: STYLE: no blank before trailing delimiter: Nm ... check. https://man.openbsd.org/mandoc.1
8d060b84 2018-04-09 09:23:46 man: Silence more mandoc warnings man -Tlint pkgconf skipping no-space macro (mdoc) An input line begins with an Ns macro, or the next argument after an Ns macro is an isolated closing delimiter. The macro is ignored. unusual Xr order (mdoc) In the SEE ALSO section, an Xr macro with a lower section number follows one with a higher number, or two Xr macros referring to the same section are out of alphabetical order. man: pkgconf.1:114:16: WARNING: skipping no-space macro man: pkgconf.1:114:39: WARNING: skipping no-space macro man: pkgconf.1:119:14: WARNING: skipping no-space macro man: pkgconf.1:119:35: WARNING: skipping no-space macro man: pkgconf.1:119:56: WARNING: skipping no-space macro man: pkgconf.1:128:28: WARNING: skipping no-space macro man: pkgconf.1:147:24: WARNING: skipping no-space macro man: pkgconf.1:217:2: WARNING: unusual Xr order: pc(5) after pkg.m4(7) man -Tlint pc whitespace at end of input line (mdoc, man, roff) Whitespace at the end of input lines is almost never semantically significant -- but in the odd case where it might be, it is extremely confusing when reviewing and maintaining documents. new sentence, new line (mdoc) A new sentence starts in the middle of a text line. Start it on a new input line to help formatters produce correct spacing. missing -width in -tag list, using 8n (mdoc) Every Bl macro having the -tag argument requires -width, too. man: pc.5:17:76: STYLE: whitespace at end of input line man: pc.5:18:50: WARNING: new sentence, new line man: pc.5:49:67: WARNING: new sentence, new line man: pc.5:87:38: WARNING: new sentence, new line man: pc.5:90:27: WARNING: new sentence, new line man: pc.5:113:66: WARNING: new sentence, new line man: pc.5:117:61: WARNING: new sentence, new line man: pc.5:123:49: WARNING: new sentence, new line man: pc.5:56:2: WARNING: missing -width in -tag list, using 6n: Bl -tag man: pc.5:80:2: WARNING: missing -width in -tag list, using 6n: Bl -tag https://man.openbsd.org/mandoc.1
3e8a55e1 2018-04-08 14:22:42 man: Silence mandoc warnings. man -Tlint pkgconf new sentence, new line (mdoc) A new sentence starts in the middle of a text line. Start it on a new input line to help formatters produce correct spacing. man: pkgconf.1:23:24: WARNING: new sentence, new line man: pkgconf.1:42:15: WARNING: new sentence, new line man: pkgconf.1:44:73: WARNING: new sentence, new line man: pkgconf.1:53:63: WARNING: new sentence, new line man: pkgconf.1:60:58: WARNING: new sentence, new line man: pkgconf.1:69:66: WARNING: new sentence, new line man: pkgconf.1:85:56: WARNING: new sentence, new line man: pkgconf.1:153:7: WARNING: new sentence, new line man: pkgconf.1:202:43: WARNING: new sentence, new line https://man.openbsd.org/mandoc.1
b0796cff 2018-03-06 20:37:43 Fix --exists description in man page (#173) pkgconf exists with 0 if all modules exist and not the other way around.
2156a74a 2018-02-28 13:00:53 cli: implement --fragment-filter (closes #167)
a7864d01 2017-12-21 02:25:09 man: pc: discuss extensions and optional gating approach for hard dependency on extensions
fef32934 2017-12-15 18:53:59 man: add pc(5) mdoc (closes #148)
7ab4dffa 2017-12-06 17:45:17 main: implement --env (closes #159)
69a05a74 2017-12-05 19:52:32 man: pkgconf(1): add crossreference to new pkg.m4(7) manpage (closes #147)
7fed573a 2017-12-05 19:47:11 man: finish pkg.m4(7)
d80d66f5 2017-12-05 19:17:31 man: add starting point on pkg.m4(7) manpage
60df6ba3 2017-12-05 18:45:06 build: move manpages to man subdir