include manpages #65

timsnyder · 2019-09-09T17:57:15Z

from prebuilt kernel.org releases on [not win] platforms. This enables the --help
option on all commands.

fixes #17

Checklist

Used a fork of the feedstock to propose changes
Bumped the build number (if the version is unchanged)
Re-rendered with the latest conda-smithy (Use the phrase @conda-forge-admin, please rerender in a comment in this PR for automated rerendering)
Ensured the license file is being packaged.

from prebuilt kernel.org releases. This enables the --help option on all commands. fixes conda-forge#17

conda-forge-linter · 2019-09-09T17:57:20Z

Hi! This is the friendly automated conda-forge-linting service.

I wanted to let you know that I linted all conda-recipes in your PR (recipe) and found some lint.

Here's what I've got...

For recipe:

Failed to even lint the recipe, probably because of a conda-smithy bug 😢. This likely indicates a problem in your meta.yaml, though. To get a traceback to help figure out what's going on, install conda-smithy and run conda smithy recipe-lint . from the recipe directory.

timsnyder · 2019-09-09T17:57:51Z

@conda-forge-admin, please rerender

timsnyder · 2019-09-09T17:58:28Z

I'm looking into the linting issue.

conda-forge-linter · 2019-09-09T17:58:34Z

Hi! This is the friendly automated conda-forge-webservice.

I tried to re-render for you, but it looks like there was nothing to do.

scopatz · 2019-09-09T18:05:06Z

recipe/build.sh


+# Install manpages
+cp -r manpages/* $PREFIX/man


Shouldn't this be $PREFIX/share/man?

Well. That's a good question. I thought the default was $PREFIX/share/man but I looked for other packages that have manpages and saw perl is installing to $PREFIX/man. I did determine that man on my ubuntu vm will find $PREFIX/man without MANPATH needing to be set.

Another good question is should we create a recipe for man so that we can configure it to correctly find manpages from $PREFIX/<wherever>?

See man man (particularly the info on MANPATH_MAP) and look at /private/etc/man.conf. A comment from that file (on my Mac):

# If people ask for "man foo" and have "/dir/bin/foo" in their PATH # and the docs are found in "/dir/man", then no mapping is required.

There are also some details at conda/conda#845

Do you guys have the manifest from all packages indexed in some searchable location? If so, I'd be happy to look to see which packages have a man directory and where they are putting it.

If you don't have such a searchable location across all packages, I can do a more brute force grind through them.

@asmeurer The magical looking closely to PATH only seems to work when MANPATH is unset and you haven't passed in -M on the cmdline. Perhaps a man package could pre-pend $PREFIX/man if MANPATH is set, otherwise, leave it unset?

I think what I have in this PR is at least working better than not having the manpages at all.

I'm also realizing that the only reasons why I have MANPATH set are really ancient, predate conda and I'll be better off if I stop setting it and let man just look at PATH.

This morning, I confirmed that my system man on RHEL6 does find manpages in $PREFIX/man without MANPATH but does not find $PREFIX/share/man. I also see that there are conda packages that install manpages into $PREFIX/share/man and as I mentioned earlier, there are packages that install into $PREFIX/man

Standardizing conda-forge on a manpage install path and updating the impacted recipes seems bigger than this PR. I'd be happy to work on that. @asmeurer and @scopatz, do you guys think we could go ahead and merge this PR?

From man man:

If you don't specify an explicit path list with -M or MANPATH, man develops its own path list based on the contents of the configura- tion file /private/etc/man.conf. The MANPATH statements in the configuration file identify particular directories to include in the search path.

So it's by design that setting MANPATH or -M overrides the defaults (it's not like PYTHONPATH which appends the defaults).

timsnyder · 2019-09-09T18:16:33Z

Looking at the recipe linting issue, this is the traceback:

(base) tsnyder:~/git-feedstock (17_include_manpages) $ conda smithy recipe-lint recipe
Traceback (most recent call last):
  File "/home/ubuntu/miniconda3/bin/conda-smithy", line 10, in <module>
    sys.exit(main())
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/conda_smithy/cli.py", line 470, in main
    args.subcommand_func(args)
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/conda_smithy/cli.py", line 365, in __call__
    return_hints=True,
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/conda_smithy/lint_recipe.py", line 573, in main
    meta = yaml.load(content)
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/ruamel/yaml/main.py", line 341, in load
    return constructor.get_single_data()
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/ruamel/yaml/constructor.py", line 111, in get_single_data
    node = self.composer.get_single_node()
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/ruamel/yaml/composer.py", line 78, in get_single_node
    document = self.compose_document()
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/ruamel/yaml/composer.py", line 101, in compose_document
    node = self.compose_node(None, None)
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/ruamel/yaml/composer.py", line 138, in compose_node
    node = self.compose_mapping_node(anchor)
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/ruamel/yaml/composer.py", line 218, in compose_mapping_node
    item_value = self.compose_node(node, item_key)
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/ruamel/yaml/composer.py", line 136, in compose_node
    node = self.compose_sequence_node(anchor)
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/ruamel/yaml/composer.py", line 179, in compose_sequence_node
    while not self.parser.check_event(SequenceEndEvent):
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/ruamel/yaml/parser.py", line 140, in check_event
    self.current_event = self.state()
  File "/home/ubuntu/miniconda3/lib/python3.7/site-packages/ruamel/yaml/parser.py", line 525, in parse_block_sequence_entry
    token.start_mark,
ruamel.yaml.parser.ParserError: while parsing a block collection
  in "<unicode string>", line 8, column 3:
      - url: https://github.com/git/gi ... 
      ^ (line: 8)
expected <block end>, but found '?'
  in "<unicode string>", line 17, column 3:
      url: https://github.com/git-for- ... 
      ^ (line: 17)

This looks like the recipe-linter is trying to read the meta.yaml without doing the jinja preprocessing. Is that the intended way for the linter to work? If so, I'll need to make the Windows build look like a multi-source build even though it really isn't.

conda-smithy reads meta.yaml without applying the preprocessing selectors. For this to work, we need to make the windows look like a multiple-source item even though it will only have a single source after the proprocessing selectors are applied. Also needed to cleanup spacing before preprocessing selectors.

conda-forge-linter · 2019-09-09T18:36:56Z

Hi! This is the friendly automated conda-forge-linting service.

I just wanted to let you know that I linted all conda-recipes in your PR (recipe) and found it was in an excellent condition.

timsnyder · 2019-09-09T18:37:37Z

I pushed another commit that makes recipe-lint happy.

timsnyder · 2019-09-09T18:40:52Z

@conda-forge-admin, please rerender

conda-forge-linter · 2019-09-09T18:41:43Z

Hi! This is the friendly automated conda-forge-webservice.

I tried to re-render for you, but it looks like there was nothing to do.

timsnyder · 2019-09-09T19:27:09Z

The linux_aarch64_ build is failing because it looks like conda build isn't creating $PREFIX/man. I was surprised that on linux_ it seemed to already exist and I took out the mkdir -p $PREFIX/man from build.sh. Perhaps I should put it back?

Yes. I should. Looks like linux_ autoconf has perl as a dependence and that creates the $PREFIX/man directory when it is installed. I'm guessing that linux_aarch64_ and linux_ppc64le_ may not have manpages in their perl packages.

not all platforms with have $PREFIX/man created by dependencies and we shouldn't rely on the deps to create the directory anyway.

scopatz · 2019-09-10T20:49:57Z

@timsnyder, let us know when this is ready for review again!

timsnyder · 2019-09-11T02:13:04Z

@scopatz I think it's ready for re-review and merging if we're done talking about where the manpages should be installed with @asmeurer

scopatz · 2019-09-11T18:16:43Z

Thanks!

phil-blain · 2019-10-07T15:49:58Z

@timsnyder, @scopatz hi! I have just done conda update git in my 'git' environment on my Mac (OS X 10.11.6) but neither man git-$cmd, git help $cmd nor git $cmd --help show the corresponding man pages (they show the system ones), although I checked they are correctly installed in $CONDA_PREFIX/man/man1. It was not clear from the conversation above, should it work on macOS ?

jakirkham · 2019-10-07T15:58:50Z

@phil-blain, please open a new issue.

Edit: Raised as issue ( #66 ).

kdpenner · 2020-05-12T14:31:27Z

I just ran condo install git and the manpages weren't installed.

jakirkham · 2020-05-12T19:31:40Z

Please raise a new issue

include manpages

5bba26f

from prebuilt kernel.org releases. This enables the --help option on all commands. fixes conda-forge#17

timsnyder requested review from djsutherland, jakirkham, msarahan, ocefpaf, pelson and scopatz as code owners September 9, 2019 17:57

scopatz reviewed Sep 9, 2019

View reviewed changes

timsnyder mentioned this pull request Sep 9, 2019

add pcre #64

Merged

4 tasks

timsnyder added 2 commits September 9, 2019 19:53

fix selector typo from conda-forge#64

5c5c213

re-add mkdir $PREFIX/man

4ccdf09

not all platforms with have $PREFIX/man created by dependencies and we shouldn't rely on the deps to create the directory anyway.

djsutherland approved these changes Sep 11, 2019

View reviewed changes

scopatz merged commit 4b1de47 into conda-forge:master Sep 11, 2019

timsnyder deleted the 17_include_manpages branch September 13, 2019 15:06

phil-blain mentioned this pull request Oct 7, 2019

man pages on macOS #66

Closed

kdpenner mentioned this pull request May 14, 2020

man pages aren't included AnacondaRecipes/git-feedstock#6

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

include manpages #65

include manpages #65

timsnyder commented Sep 9, 2019 •

edited

Loading

conda-forge-linter commented Sep 9, 2019

timsnyder commented Sep 9, 2019

timsnyder commented Sep 9, 2019

conda-forge-linter commented Sep 9, 2019

scopatz Sep 9, 2019

timsnyder Sep 9, 2019

asmeurer Sep 9, 2019

timsnyder Sep 9, 2019

timsnyder Sep 10, 2019

timsnyder Sep 10, 2019

asmeurer Sep 10, 2019

timsnyder commented Sep 9, 2019

conda-forge-linter commented Sep 9, 2019

timsnyder commented Sep 9, 2019

timsnyder commented Sep 9, 2019

conda-forge-linter commented Sep 9, 2019

timsnyder commented Sep 9, 2019 •

edited

Loading

scopatz commented Sep 10, 2019

timsnyder commented Sep 11, 2019 •

edited

Loading

scopatz commented Sep 11, 2019

phil-blain commented Oct 7, 2019

jakirkham commented Oct 7, 2019 •

edited

Loading

kdpenner commented May 12, 2020

jakirkham commented May 12, 2020

include manpages #65

include manpages #65

Conversation

timsnyder commented Sep 9, 2019 • edited Loading

conda-forge-linter commented Sep 9, 2019

timsnyder commented Sep 9, 2019

timsnyder commented Sep 9, 2019

conda-forge-linter commented Sep 9, 2019

scopatz Sep 9, 2019

Choose a reason for hiding this comment

timsnyder Sep 9, 2019

Choose a reason for hiding this comment

asmeurer Sep 9, 2019

Choose a reason for hiding this comment

timsnyder Sep 9, 2019

Choose a reason for hiding this comment

timsnyder Sep 10, 2019

Choose a reason for hiding this comment

timsnyder Sep 10, 2019

Choose a reason for hiding this comment

asmeurer Sep 10, 2019

Choose a reason for hiding this comment

timsnyder commented Sep 9, 2019

conda-forge-linter commented Sep 9, 2019

timsnyder commented Sep 9, 2019

timsnyder commented Sep 9, 2019

conda-forge-linter commented Sep 9, 2019

timsnyder commented Sep 9, 2019 • edited Loading

scopatz commented Sep 10, 2019

timsnyder commented Sep 11, 2019 • edited Loading

scopatz commented Sep 11, 2019

phil-blain commented Oct 7, 2019

jakirkham commented Oct 7, 2019 • edited Loading

kdpenner commented May 12, 2020

jakirkham commented May 12, 2020

timsnyder commented Sep 9, 2019 •

edited

Loading

timsnyder commented Sep 9, 2019 •

edited

Loading

timsnyder commented Sep 11, 2019 •

edited

Loading

jakirkham commented Oct 7, 2019 •

edited

Loading