Skip to content

Scripts for regenerating documentation#215

Merged
igaw merged 3 commits intolinux-nvme:masterfrom
hreinecke:regen-doc
Feb 3, 2022
Merged

Scripts for regenerating documentation#215
igaw merged 3 commits intolinux-nvme:masterfrom
hreinecke:regen-doc

Conversation

@hreinecke
Copy link
Copy Markdown
Collaborator

Import the 'kernel-doc' script from the linux kernel sources and add scripts to regenerate libnvme.rst and the manual pages.

Add DOC: statements to the header files to have each header file
start its own section in the API documentation.

Signed-off-by: Hannes Reinecke <hare@suse.de>
Some function descriptions weren't properly specified.

Signed-off-by: Hannes Reinecke <hare@suse.de>
@igaw
Copy link
Copy Markdown
Collaborator

igaw commented Feb 2, 2022

Any particular reason why the scripts are in internal? We have a make.bat in the doc dir (do we need it?). Also I was thinking on hooking it up as new conditional target to meson (in case this is supported. need to study the docs)

@hreinecke
Copy link
Copy Markdown
Collaborator Author

No particular reason. Just wanting to share what I've been able to find out; getting there was painful enough, and others shouldn't be made to suffer the same way.
Of course having it as a meson target is preferred. And while we're at it, the current 'meson -Dman=true' thingie doesn't actually generate the man pages; it just pushes everything from libnvme.rst into libnvme.2. And even that is in the wrong location.
But that's a different story :-)

@igaw
Copy link
Copy Markdown
Collaborator

igaw commented Feb 2, 2022

When the user doesn't tell meson to build the documentation via -Dman=true it installs the pre compiled ones? Would this work? Or do we an option to install only the documentation on request?

@igaw igaw added the bug Something isn't working label Feb 2, 2022
@igaw igaw added this to the 1.0 milestone Feb 2, 2022
@hreinecke
Copy link
Copy Markdown
Collaborator Author

Yes, that was the plan. With normal build the pre-compiled manpages get installed, and with 'meson -Dman=true' the manpages get regenerated.

@hreinecke
Copy link
Copy Markdown
Collaborator Author

Only that 'meson -Dman=true' doesn't do that, cf issue #218.

Import the 'kernel-doc' script from the linux kernel sources and
add scripts to regenerate libnvme.rst and man-pages.

Signed-off-by: Hannes Reinecke <hare@suse.de>
[dwagner: moved scripts from internal to doc]
Signed-off-by: Daniel Wagner <dwagner@suse.de>
@igaw
Copy link
Copy Markdown
Collaborator

igaw commented Feb 3, 2022

I've just moved the scripts to the doc dir.

@igaw igaw merged commit 47fd557 into linux-nvme:master Feb 3, 2022
@hreinecke hreinecke deleted the regen-doc branch March 28, 2023 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants