[PATCH 0/1] buildstream man pages portability fix

Tristan Van Berkom tristan.vanberkom at codethink.co.uk
Mon Aug 28 16:37:03 BST 2017


On Mon, 2017-08-28 at 16:02 +0100, Richard Ipsum wrote:
> Dear Baserock,
> 
> I was curious about buildstream and thought I might try it.
> It's nice to see a project using man pages written the old fashioned way,
> here are some portability fixes for those man pages.
> 
> If you prefer me to open this as a merge request on gitlab I could do that,
> but it requires creating an account and it seems unlikely that I will need
> to make further use of that account since I'm not a real contributor.
> 
> I've preserved the original layout of these man pages as much as possible,
> but the indentation will look slightly different now. This patch makes
> no change to the content of these man pages.
> 

Hi Richard !

Thanks for showing an interest :)

Please feel free to join us on buildstream-list[0] and discuss
buildstream things there too.

Also, sorry if this was not obvious to you but that is not the correct
thing to fix. We use click for the CLI frontend which has a little
extension for generating documentation (called click-man[1]).

There are some notes in HACKING.rst about man page generation, and an
open issue about automating the docs generation[2] (we are currently
just committing the generated files as a workaround for that bug).

What is non portable about the generated man pages and do you think you
could file a bug about that with the click-man project ?


[0]: https://mail.gnome.org/mailman/listinfo/buildstream-list
[1]: https://github.com/click-contrib/click-man
[2]: https://gitlab.com/BuildStream/buildstream/issues/8


> Hope this helps,
> Richard
> 
> Richard Ipsum (1):
>   man: portability tweaks
> 
>  man/bst-artifact-receive.1 |  2 +-
>  man/bst-checkout.1         |  2 +-
>  man/bst-fetch.1            | 17 ++++++----
>  man/bst-shell.1            |  4 +--
>  man/bst-show.1             | 79 ++++++++++++++++++++++++++--------
> ------------
>  man/bst-source-bundle.1    | 15 +++++----
>  man/bst-track.1            | 15 +++++----
>  man/bst-workspace.1        | 36 ++++++++++++++-------
>  man/bst.1                  | 72 ++++++++++++++++++++++++++++------
> --------
>  9 files changed, 149 insertions(+), 93 deletions(-)
> 




More information about the baserock-dev mailing list