[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#939999: libvulkan-dev: Please include manpages for all library functions, structs, extensions



Package: libvulkan-dev
Version: 1.1.114.0-1
Followup-For: Bug #939999

Just a minor update,

https://www.khronos.org/registry/vulkan/

section 'API Reference Pages' says:

""" In addition to the format published here, it is possible to generate other
formats from the reference page sources, such as PDF or Unix nroff man page
sources. """

I couldn't find the nroff generator in the git repo, but maybe I didn't
search well, (maybe it was removed in master head in git?).

Also, I found out that indeed it is possible, as Arch does ship with vulkan man
pages:


https://aur.archlinux.org/packages/vulkan-man-git/

Examples:

https://manned.org/VkDeviceCreateInfo.3
https://manned.org/vkCreateGraphicsPipelines.3


Sources (not upstreamed fully yet) are in this forked repo:
https://github.com/Ryp/Vulkan-Docs

and some diffs can be seen here:

https://github.com/KhronosGroup/Vulkan-Docs/compare/master...Ryp:master

So, it looks pretty easy. Bulk of the work is done by asciidoctor output plugin,
which is part of official upstream asciidoctor:

https://asciidoctor.org/docs/user-manual/#man-pages

So, there is very little extra work to do beyond maybe adding a small patch to
docs, and adding a package.


Thank you.

-- System Information:
Debian Release: bullseye/sid
  APT prefers testing-debug
  APT policy: (500, 'testing-debug'), (500, 'testing'), (1, 'experimental')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 5.2.0-2-amd64 (SMP w/32 CPU cores)
Kernel taint flags: TAINT_PROPRIETARY_MODULE, TAINT_OOT_MODULE, TAINT_UNSIGNED_MODULE
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8), LANGUAGE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /usr/bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

Versions of packages libvulkan-dev depends on:
ii  libvulkan1  1.1.114.0-1

libvulkan-dev recommends no packages.

libvulkan-dev suggests no packages.

-- no debconf information


Reply to: