Skip to content

Add manpage for fluster(1)#330

Merged
mdimopoulos merged 2 commits into
fluendo:masterfrom
obbardc:wip/obbardc/add-manpage
Apr 28, 2026
Merged

Add manpage for fluster(1)#330
mdimopoulos merged 2 commits into
fluendo:masterfrom
obbardc:wip/obbardc/add-manpage

Conversation

@obbardc
Copy link
Copy Markdown
Contributor

@obbardc obbardc commented Dec 31, 2025

Add a Markdown source for the manpage, build instructions and the generated manpage into the repository.
Install the manpage to share/man/man1 via setuptools data-files.

We currently ship this manpage as part of the Debian fluster package; I am simply upstreaming it so that we don;t need to carry it in the debian package.

@rgonzalezfluendo
Copy link
Copy Markdown
Contributor

Cool, I will use it in the AUR Arch Linux package

@mdimopoulos
Copy link
Copy Markdown
Contributor

@obbardc out of curiosity and ignorance, does the name have to be fluster.1?

@obbardc obbardc force-pushed the wip/obbardc/add-manpage branch 2 times, most recently from d0a6fb8 to 281bf08 Compare April 2, 2026 20:30
@obbardc
Copy link
Copy Markdown
Contributor Author

obbardc commented Apr 2, 2026

@mdimopoulos says:

@obbardc out of curiosity and ignorance, does the name have to be fluster.1?

The manpage does not strictly have to be that exact source name, but the installed manpage should be fluster.1 with general unix conventions (command name + section 1, for commands).

For the Makefile target etc, it can be changed if needed. What do you think?

@obbardc obbardc changed the title docs: Install fluster(1) manpage docs: Add manpage for fluster(1) Apr 2, 2026
@obbardc obbardc force-pushed the wip/obbardc/add-manpage branch from 281bf08 to d757e5f Compare April 2, 2026 20:38
@obbardc obbardc changed the title docs: Add manpage for fluster(1) Add manpage for fluster(1) Apr 2, 2026
@obbardc obbardc marked this pull request as ready for review April 2, 2026 20:39
@obbardc obbardc force-pushed the wip/obbardc/add-manpage branch from d757e5f to e2077be Compare April 2, 2026 20:40
@mdimopoulos
Copy link
Copy Markdown
Contributor

@mdimopoulos says:

@obbardc out of curiosity and ignorance, does the name have to be fluster.1?

The manpage does not strictly have to be that exact source name, but the installed manpage should be fluster.1 with general unix conventions (command name + section 1, for commands).

For the Makefile target etc, it can be changed if needed. What do you think?

Alright. Fine by me as it is

@obbardc
Copy link
Copy Markdown
Contributor Author

obbardc commented Apr 10, 2026

@rgonzalezfluendo @mdimopoulos can this be merged ? Any changes needed ? thanks!

obbardc added 2 commits April 28, 2026 13:40
Add a Markdown source for the manpage, build instructions and the
generated manpage into the repository.

Install the manpage to share/man/man1 via setuptools data-files.

Signed-off-by: Christopher Obbard <obbardc@debian.org>
Add a simple CI job to check that the comitted manpage is up-to-date.

Signed-off-by: Christopher Obbard <obbardc@debian.org>
@mdimopoulos mdimopoulos force-pushed the wip/obbardc/add-manpage branch from 064b460 to 293eff3 Compare April 28, 2026 11:40
@mdimopoulos mdimopoulos merged commit c596d89 into fluendo:master Apr 28, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants