Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

i3 man & doc #27068

Closed
wants to merge 2 commits into from
Closed

i3 man & doc #27068

wants to merge 2 commits into from

Conversation

Profpatsch
Copy link
Member

Motivation for this change

man pages and documentation have been missing. Introduces a helper to correctly copy manpages. See commits.

Some package distributions come with a flat folder containing all manpages.
Those need to be put into a fixed folder structure, and `distributeManpages`
does that.
@mention-bot
Copy link

@Profpatsch, thanks for your PR! By analyzing the history of the files in this pull request, we identified @offlinehacker, @fpletz and @Ma27 to be potential reviewers.

@grahamc
Copy link
Member

grahamc commented Jul 16, 2017

It seems a bit strange to make a whole helper for this copy task. That is the only hold-up on me merging.

Copy link
Member Author

@Profpatsch Profpatsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems a bit strange to make a whole helper for this copy task.

I created the helper because it’s non-trivial shell code to get right and might be useful for other packages (aka build-support). Plus, there’s a few tests that will be included in the upcoming test suite for build-support.

for i in $(seq 0 9); do
for f in $(find -name "*.$i"); do
to="$outpath/man/man$i"
install -D --target-directory "$to" "$f"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably be -m644.

@samueldr
Copy link
Member

A year later, what's the verdict?

Have we seen situations where the helper would be required? Should this be merged?

Though, I'm not sure the helper is right.

  • I don't think it handles compressed ($x.1.gz) man pages?
  • I don't think it handles non-standard (other than 0-9) manpages
~/.../nixos/tests $ nix-locate -r 'man/man' | cut -d'/' -f6-7 | sort -u | grep ^man/
man/man
man/man0p
man/man1p
man/man1x
man/man3p
man/manm
man/mann
man/mant
man/manx

While I can understand the value of the helper, I'm not sure the implementation fills the role (yet).

@Profpatsch
Copy link
Member Author

Personally I have no strong incentive to get this merged (I don’t use i3 at the moment). Please feel free to push changes to this branch if you want to use the work I already did, otherwise I’ll close.

@Profpatsch Profpatsch closed this Jan 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants