summaryrefslogtreecommitdiffstats
path: root/INSTALL (follow)
Commit message (Collapse)AuthorAgeLines
* GNUmakefile, INSTALL, RELEASE: Expand 'make help' to document dependenciesAlejandro Colomar2024-03-19-17/+8
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* share/mk/: Reorganize build dependenciesAlejandro Colomar2024-02-17-49/+11
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk: Remove 'V' variableAlejandro Colomar2023-08-28-5/+1
| | | | | | | | | | | | | | GNU Make (since version 4.4) provides the same functionality with `--debug=print`. Remove this custom variable, which is now redundant with the new option. - Define .SILENT: unconditionally. - Define HIDE_ERR unconditionally, and let the user redefine it to an empty string. Document this. Cc: Paul Smith <psmith@gnu.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* INSTALL, README, RELEASE: Update references to GNUmakefileAlejandro Colomar2023-08-17-1/+1
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* CONTRIBUTING, INSTALL, README, RELEASE: Reflow to 72 columnsAlejandro Colomar2023-07-08-48/+52
| | | | | | This makes it easier to quote in emails. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* INSTALL: Fix references to lib/ -> share/mk/Alejandro Colomar2023-04-17-5/+5
| | | | | Fixes: edaa12e6b ("*.mk: Move makefiles from lib/ to share/mk/") Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk, INSTALL: build-src-c: Optimize pipelineAlejandro Colomar2023-04-14-1/+1
| | | | | | | | | Calling man(1) is slow. Since we only need to format the page, calling mandoc(1) is faster and simpler (we could also use groff(1), but mandoc(1) is probably faster and simpler than groff(1) too). This brings times down ~3x in my system. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* *.mk, CONTRIBUTING, INSTALL: lint, build, check: Reorganize some targetsAlejandro Colomar2023-04-02-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Some targets which were under lint-* were really building cat pages, so let's call it build-catman, since it's what it is. As part of the build, it will report warnings, of course, as any other build system, so nothing really changed, except for the target names, and the path in the build tree where the cat pages (and intermediate files) are placed, which is now directly under <.tmp/man/*>. Some other targets were checking that the cat pages were correct after the build, so those targets have been moved to check-* targets. Document that contributors should run both the 'lint' and 'check' targets to check the correctness of their patches. `make all`, a.k.a. `make build`, now builds _all_ that can be built, including cat pages, and C programs. Implementation detail: $LINTMAN has been renamed, since now it's used also for things that are not linters. Call it $NONSO_MAN, since it's a list of the non-'.so' man pages, which are the ones we want to lint, build, and check. Future directions: I plan to implement 'build-html' using groff(1), which will reuse part of the build-catman pipeline. That will produce much higher quality HTML manual pages. Cc: G. Branden Robinson <g.branden.robinson@gmail.com> Cc: Elliott Hughes <enh@google.com> Cc: Oskari Pirhonen <xxc3ncoredxx@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* INSTALL, Makefile: Document available variables.Alejandro Colomar2023-03-11-12/+10
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* INSTALL, cmd.mk, install-man.mk: Support installing compressed pagesAlejandro Colomar2023-03-09-0/+3
| | | | | | | | | | | | | | | | | | | Distributions usually install compressed (.gz) pages to reduce space. Let's support this in our build system, as a command-line variable "Z", which is empty by default, but can be set to a file extension to append to the page names (and the appropriate compression program will be used). For now, the only compression supported is ".gz". Example: $ make install Z=.gz This can be combined with LINK_PAGES, to produce compressed pages and use symbolic links for the link pages: $ make install Z=.gz LINK_PAGES=symlink Signed-off-by: Alejandro Colomar <alx@kernel.org>
* cmd.mk, install-man.mk: Allow installing link pages as symlinksAlejandro Colomar2023-03-09-0/+1
| | | | | | | | | | | | We keep them as .so "includes" in our source code, but if some distribution wants to have them as symlinks in their filesystem, make it easy for them to install as such, by specifying 'LINK_PAGES=symlink'. Example: $ make install LINK_PAGES=symlink Signed-off-by: Alejandro Colomar <alx@kernel.org>
* INSTALL, Makefile, cmd.mk, lint-man.mk: Lint about '\" t' comment for tbl(1)Alejandro Colomar2022-12-15-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is to make sure that we have correct \" t comments in the pages, which are necessary for the Debian package checker: On 8/19/22 22:21, Jakub Wilk wrote: > * Michael Kerrisk <mtk.manpages@gmail.com>, 2020-07-24 12:13: >> For 15 years or at least, I've not paid any attention to adding the >> 't' comments when I added tables to pages, and I do recall anyone >> reporting ill effects. So, I'm inclined to apply Mike's patch, but >> will hold off a moment, in case there's other feedback. > > I'm a bit late, but... > > Lintian, the Debian package checker, sets the MANROFFSEQ environment > variable to empty string as a speed optimization. This turns off > loading preprocessors that weren't explicitly declared in the source. > The lack of '\" comments can cause false positives (and maybe also > false negatives?) in Lintian. > > The use of $MANROFFSEQ for Lintian was proposed here: > https://bugs.debian.org/677874 > > Beware that the man(1) man page does not correctly explain what > $MANROFFSEQ does: <https://bugs.debian.org/971009> Also update the dependencies list, since now we also need head(1) and tail(1) for linting man(7) source. Link: <https://lore.kernel.org/linux-man/07a7d4e7-79a6-b2c3-6892-1e39a0679f27@gmail.com/T/#mcf36c8a387fd5ff4f800dc220e3dbdd229b556bd> Reported-by: Jakub Wilk <jwilk@jwilk.net> Cc: Mike Frysinger <vapier@gentoo.org> Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com> Cc: Michael Kerrisk <mtk.manpages@gmail.com> Cc: Stefan Puiu <stefan.puiu@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* INSTALL: tfixEric Biggers2022-12-15-1/+1
| | | | | Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* INSTALL, RELEASE, cmd.mk, lint-man.mk: Use expr(1) instead of bc(1)Alejandro Colomar2022-11-17-1/+1
| | | | | | | | | | Both bc(1) and expr(1) are in POSIX. However, expr(1) is provided by GNU coreutils, and seems simpler to use. This will simplify the dependencies required to package the project. Document the change in dependencies too. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* INSTALL: Rewrite and expandAlejandro Colomar2022-10-31-14/+177
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* INSTALL, RELEASE: Add RELEASE file with instructions for releasingAlejandro Colomar2022-10-19-0/+6
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* Makefile, README, INSTALL: Improve INSTALL documentationAlejandro Colomar2022-07-10-0/+13
Add a 'make help' target to document the features of our Makefile. Move all documentation about installing from the README to a new INSTALL file, following GNU coding standards. See <https://www.gnu.org/prep/standards/html_node/Releases.html#Releases>. INSTALL contains minimal information, and defers to 'make help' for the rest. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-01 14:13:52 +0000