Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Release the man page #355
I suppose there are two basic ways for getting the rendered man page into a target installation:
From a packaging and user's perspective, avoiding an extra dependency such as Pandoc is nice. There is, of course, plenty of software that requires an extra dependency for building documentation, so this is not that unusual.
From a gocryptfs developer's perspective, depending on the release process, it might be nice to avoid installing yet another tool and adding this extra step.
(For my own context, I installed gocryptfs on macOS with Homebrew. The current formula uses the
It seems like option 1 is the current situation, but I think option 2 is better, esp. if it can be automated to ease the maintenance burden.
So the "usual way" is (1), which is what Debian, Arch and Ubuntu do. I'm surprised that installing through homebrew does not install the man page.
I see the point of avoiding the pandoc dependency. Looking at https://formulae.brew.sh/formula/gocryptfs , what does "bottle" mean? Pre-built binaries?
@rfjakob What is the difference in the way the
@lechner Right, that is the same terminology I used in the report above.
@lechner It's true that a user does not need Pandoc to use gocryptfs, but I'm guessing you mean that a user will not need Pandoc to render the man page. That depends on how the user obtains gocryptfs. A user obtaining a
I guess the question comes down to whether the GitHub release process for gocryptfs should be changed to include rendering and releasing the man page. If the answer is no, I'll go over to Homebrew and query about adding Pandoc as a build dependency to include the man page.
As it does not really cause extra work during the release process, I will include the man pages in the source tarball ( commit 61940a9 ).
Well, linux-static is the compiled binary plus the generated man pages, while "src" and "src-deps" only zips up the source files. Now it also generates the man pages and includes them.