yestax/setup
1
0
Fork 0
Code Issues 25 Pull requests Projects Releases Packages 18 Wiki Activity Actions

feature/doc-to-md #82

Merged
yestax merged 86 commits from feature/doc-to-md into main 2026-05-28 00:48:14 +02:00
Conversation 3 Commits 86 Files changed 66 +1661 -822
yestax commented 2026-05-18 14:07:38 +02:00
Owner
Copy link

This PR changes the way documentation is handled.
The plain text files only readable by a text editor are now converted to manpages. This allows reading using man command everywhere and search with tools like apropos.

The .txt files were converted to .7setup.md files (so written in Markdown) and are converted at package build time by pandoc to man pages (troff).

The man section is '7setup' to be in section 7 but dodge any collision problem with already existing man pages in section 7 with the same name.

To get the documentation:

man build-rpm (will go through the search order)

To query this documentation specifically

man 7setup build-rpm

In the future other sections may be used or documentation may change to be in plain 7 section for instance.

This PR changes the way documentation is handled. The plain text files only readable by a text editor are now converted to manpages. This allows reading using man command everywhere and search with tools like apropos. The .txt files were converted to .7setup.md files (so written in Markdown) and are converted at package build time by pandoc to man pages (troff). The man section is '7setup' to be in section 7 but dodge any collision problem with already existing man pages in section 7 with the same name. To get the documentation: man build-rpm (will go through the search order) To query this documentation specifically man 7setup build-rpm In the future other sections may be used or documentation may change to be in plain 7 section for instance.
yestax added this to the Setup v1.3.X milestone 2026-05-18 14:07:38 +02:00
yestax self-assigned this 2026-05-18 14:07:38 +02:00 
Allow man automatic discover as 7 subsection
yestax commented 2026-05-18 14:12:37 +02:00
Author
Owner
Copy link

TODO: flatten man pages in .spec file and install them

TODO: flatten man pages in .spec file and install them
install_files now handle flattening files in the same target directory.
New option --flatten|-f that will install all files from the glob in the
same target directory.
Duplicate filenames are let handled to the consumer.
yestax commented 2026-05-20 00:51:57 +02:00
Author
Owner
Copy link

new flatten option to install_files.

TODO: pandoc the files to generate them.

Careful rpm automatically compress the files added to mandir.
Try to own them as a glob. The glob owning shoul be reserved to some kind of install, such as man pages. Make an option for that.

A clear function name own_file could be great.

new flatten option to install_files. TODO: pandoc the files to generate them. Careful rpm automatically compress the files added to mandir. Try to own them as a glob. The glob owning shoul be reserved to some kind of install, such as man pages. Make an option for that. A clear function name own_file could be great.
yestax commented 2026-05-27 13:37:14 +02:00
Author
Owner
Copy link

Implementing an own function. It owns a directory or a file giving it the right attributes.

TODO: pandoc the files to generate them.

Careful rpm automatically compress the files added to mandir.
Try to own them as a glob. The glob owning shoul be reserved to some kind of install, such as man pages. Make an option for that.
When saying glob, it is intended for one file. Example: own "manpage.7setup*" meaning own this manpages regardless of its compression algorithm that you don't control.

Implementing an own function. It owns a directory or a file giving it the right attributes. TODO: pandoc the files to generate them. Careful rpm automatically compress the files added to mandir. Try to own them as a glob. The glob owning shoul be reserved to some kind of install, such as man pages. Make an option for that. When saying glob, it is intended for one file. Example: own "manpage.7setup*" meaning own this manpages regardless of its compression algorithm that you don't control.
register directories using attributes
remove trailing parenthesis
Allows owning with a glob
yestax changed title from WIP: feature/doc-to-md to feature/doc-to-md 2026-05-28 00:46:12 +02:00
yestax merged commit 8a381b907f into main 2026-05-28 00:48:14 +02:00
yestax deleted branch feature/doc-to-md 2026-05-28 00:48:14 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bug
Something is not working

  
documentation
Related to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature

  
help wanted
Need some help

  
invalid
Something is wrong

  
maintenance
Make the repository more maintainable

  
obsolete
Another issue implemented this in a better way

  
question
More information is needed

  
wontfix
This won't be fixed

No labels
bug
documentation
duplicate
enhancement
help wanted
invalid
maintenance
obsolete
question
wontfix
Milestone
Clear milestone
No items
No milestone
Setup v1.3.X
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
yestax
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
yestax/setup!82
No description provided.