Auto-generator Vulkan-Docs manpages Tested mainly on Ubuntu but should works the same on other distros. Not tested on macOS, and Windows. It would need slightly modifications on top of parameters supplied to each command as it might have different variants. PRs welcome.
Vulkan-Docs has man source files which can be converted into manpages with a few clean-up/reformat ontop but their decision doesn't include maintaining of manpages generation code in the repo. So in short, it is possible to do it and this project will serve that purpose.
Notice those normative keywords, and inline code format.
- NodeJS (only if users target to build manpages against
Vulkan-Docs
API versionv1.2.137
or newer) - Asciidoctor (package name
asciidoctor
on debian-based distro)
make
- Build lastest spec release versionmake SPECV=v1.2.138
- Build a custom spec release version.SPECV
shorts for spec version. You can get list of spec versions here. Note: For now, v1.2.131 to v1.2.138 are built without errors.
make install
This will install all generated manpages from Vulkan-Docs/out/man/
to your /usr/local/man/man3/
.
make clean
This will remove all generated files resulting from make
. This will only remove generated files inside Vulkan-Docs directory.
It doesn't have any effect to your installed manpages on your system.
make purge
This will remove entire directory Vulkan-Docs
. This is equivalent of manually removing such directory yourself.
The script will perform the following operations
- Clone Vulkan-Docs into
Vulkan-Docs
then make sure everytime it has the lastet commits and (release) tags. - (if need) Perform installation of packages from
npm
(NodeJS) - Make sure the repo is latest
- Start fresh, and checkout a target release tag of per instructed (if not supply via command line's parameter, then it will base on lastest release)
- Inject patch for
Makefile
as seen frompatches/Makefile
without heavily modify originalMakefile
source that much - Clean
Vulkan-Docs
to ensure freshness on behalf of itsMakefile
- Build manpages only
Vulkan-Docs
on behalf of itsMakefile
- Clean or reformat some artifacts as seen from generated manpages
Thanks to Ryp for his inspiring PR to make manpages generation possible. The core logic to generate manpage of this project is based on top of that.
The script files of this repository not include the genereated artifact, man source files, or generated manpages are licensed under MIT, Wasin Thonkaew.
Artifactrs, man source files, or generated manpages (simply, what's inside Vulkan-Docs
directory) are based on original Vulkan-Docs's multiple Licenses.