mirror of
https://git.openafs.org/openafs.git
synced 2025-01-18 15:00:12 +00:00
c66971ce42
The generate-man script is currently a shell script which invokes the pod2man command for each pod file to be converted into a man page. This makes the pod conversion slow, since we load Perl and create a Pod::Man parser for each pod file. In addition to being slow, generate-man leaves behind a partially created man page when an error is encountered during the pod2man execution. To fix these issues, rewrite generate-man as a Perl script which uses the Pod::Man module directly. The Pod::Man parser is created only once and is reused to generate each man page. The Pod::Man module supports this type of batch mode operation by clearing its internal state after each man page is created. We have some special processing to determine the man page names for the pages in section 3, so create a sub class to handle the pod filename to man page title determination, and add a helper function to support processing more than one section with a single parser instance. Be sure to cleanup any partially created man pages if an error is encountered during the pod to man conversion. This will let us use this script in the Makefiles in the future. Change-Id: I8d3cce1edc62c490e93d05f72609dfde4b599a1b Reviewed-on: https://gerrit.openafs.org/15774 Reviewed-by: Mark Vitale <mvitale@sinenomine.net> Tested-by: Mark Vitale <mvitale@sinenomine.net> Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Cheyenne Wills <cwills@sinenomine.net> Reviewed-by: Michael Meffie <mmeffie@sinenomine.net> |
||
|---|---|---|
| build-tools | ||
| doc | ||
| src | ||
| tests | ||
| .gitignore | ||
| .gitreview | ||
| .mailmap | ||
| .splintrc | ||
| acinclude.m4 | ||
| CODING | ||
| configure-libafs.ac | ||
| configure.ac | ||
| CONTRIBUTING | ||
| INSTALL | ||
| libafsdep | ||
| LICENSE | ||
| Makefile-libafs.in | ||
| Makefile.in | ||
| NEWS | ||
| NTMakefile | ||
| README | ||
| README-WINDOWS | ||
| regen.sh | ||
AFS is a distributed file system that enables users to share and access all of the files stored in a network of computers as easily as they access the files stored on their local machines. The file system is called distributed for this exact reason: files can reside on many different machines, but are available to users on every machine. OpenAFS 1.0 was originally released by IBM under the terms of the IBM Public License 1.0 (IPL10). For details on IPL10 see the LICENSE file in this directory. The current OpenAFS distribution is licensed under a combination of the IPL10 and many other licenses as granted by the relevant copyright holders. The LICENSE file in this directory contains more details, thought it is not a comprehensive statement. See INSTALL for information about building and installing OpenAFS on various platforms. See CODING for developer information and guidelines. See NEWS for recent changes to OpenAFS.