Deleting manpage markdown leave roff behind #4542
Comments
This comment was marked as off-topic.
This comment was marked as off-topic.
|
On a related note, why do we have to keep the man pages committed in the repository? |
|
AFAIK it is so Elektra can be built (including full docs) without the somewhat obscure |
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
|
Thank you, yes let us focus on the main point. It is suitable for FLOSS. The same is true for checking if Doxygen might work as alternative. I created #4551. Let us please avoid such unstructured discussions about "Why?" in the future (now hidden above), as it takes our precious time and, without a decision as result, doesn't lead anywhere. I added the current status as draft decision "manpages.md" in #4528, so that this decision is not lost (again). |
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
|
One final note from me - my question was meant to reevaluate whether the issue brought up here is actually an issue. If we dont check in the man pages there is no Need to keep them in sync. |
flo91
changed the title
flo91
changed the title
|
I mark this stale as it did not have any activity for one year. I'll close it in two weeks if no further activity occurs. If you want it to be alive again, ping by writing a message here or create a new issue with the remainder of this issue. |
|
I closed this now because it has been inactive for more than one year. If I closed it by mistake, please do not hesitate to reopen it or create a new issue with the remainder of this issue. |
Our manpages are written as markdown in
doc/helpand then converted to roff and stored indoc/man. Sincedoc/manis also committed to the repo, the folders have to be kept in sync. We have a CI job that checks that all files have been generated. But if a file is deleted fromdoc/helpthere is nothing that ensures the file is also deleted fromdoc/man.Ideally, the old file would be deleted from
doc/manautomatically during the build. But there should at least be a CI job that checks that we don't have roff files without markdown sources.The text was updated successfully, but these errors were encountered: