binutils and gcc manpages hidden by wrappers #43547

bgamari · 2018-07-15T00:43:48Z

Issue description

The gcc and bin-utils wrappers don't expose the underlying derivations' man outputs.

Steps to reproduce

nix run nixpkgs.binutils.man -c man ld
Notice that the manpage is not found

Technical details

 - system: `"x86_64-linux"`
 - host os: `Linux 4.16.14, NixOS, 18.03.132646.08d245eb31a (Impala)`
 - multi-user?: `yes`
 - sandbox: `no`
 - version: `nix-env (Nix) 1.12pre5788_e3013543`
 - channels(root): `"nixos-18.03.132646.08d245eb31a, nixpkgs-18.09pre142651.95a8cb3ade1"`
 - channels(ben): `"nixpkgs-18.03pre126020.931a0b8be80"`
 - nixpkgs: `/nix/var/nix/profiles/per-user/root/channels/nixos/nixpkgs`

The text was updated successfully, but these errors were encountered:

bgamari · 2018-07-15T00:45:03Z

@Ericson2314, perhaps you know of an easy way to resolve this? Perhaps just symlink the manpages into the wrappers' output?

infinisil · 2018-07-17T19:35:39Z

It seems to only propagate man pages via propagated-user-env-packages:

nixpkgs/pkgs/build-support/cc-wrapper/default.nix

Lines 261 to 269 in bf2a009

    
               + optionalString propagateDoc '' 
        
                 ## 
        
                 ## Man page and info support 
        
                 ## 
        
                 mkdir -p $man/nix-support $info/nix-support 
        
                 printWords ${cc.man or ""}  > $man/nix-support/propagated-user-env-packages 
        
                 printWords ${cc.info or ""}  > $info/nix-support/propagated-user-env-packages 
        
               ''

This has the problem of only working when you actually install it into a profile, see #43049.

The fix would be to add something like

ln -s ${cc.man}/share $man

matthewbauer · 2018-08-01T22:06:17Z

@bgamari nix run has no knowledge of MANPATH. It only touches PATH. I think there may be a way to get MANPATH set based on PATH but I have never gotten that to work (multiple outputs probably break it).

For now you can do:

MANPATH=$(nix-build -E 'with import <nixpkgs> {}; lib.getOutput "man" stdenv.cc.bintools.bintools')/share/man man ld
MANPATH=$(nix-build -E 'with import <nixpkgs> {}; lib.getOutput "man" stdenv.cc.cc')/share/man man gcc

We definitely need a more versatile solution for this though.

A lot of people have setups to collect all of the manpages to install:

{
  packageOverrides = pkgs: with pkgs; {
    manpages = buildEnv {
      name = "manpages";
      paths = [ stdenv.cc.cc stdenv.cc.bintools.bintools ];
      extraOutputsToInstall = ["man"];
      pathsToLink = [ "/share/man" ];
    };
  };
}

Then you can just do nix-env -iA manpages. Then just do export MANPATH=$HOME/.nix-profile/share/man. But this is kind of a high bar to setup correctly.

Ericson2314 · 2018-08-02T22:59:02Z

Yes this is just a mistake @oxij and I forgot to correct. It is done correctly in bintools-wrapper with nix-support/propagated-build-inputs, which is strictly stronger. The two wrapper scripts should work the same way.

oxij · 2018-08-03T07:10:04Z

@Ericson2314 I see, yep, that's a bug. Do you want me to fix this or do you want to do this yourself?

Ericson2314 · 2018-08-03T13:44:50Z

To be clear it's really my fault, not yours :). I added the binutils one and didn't update the original, so I just didn't finish the job. You didn't touch the propagation part at al, so that would have been an out out of scope change.

That said, if you could do this I'd really appreciate it. I have a few other things to tackle.

oxij · 2018-08-05T19:23:52Z

See #44516.

oxij · 2018-08-08T16:41:02Z

I think #44558 actually fixes this. At least I can see both `man` and `info` for both `gcc` and `ld` in a minimal NixOS VM.

teto · 2018-08-09T02:30:12Z

Does that solve it for readelf too ? I couldn't get access to the man either (https://linux.die.net/man/1/readelf)

oxij · 2018-08-09T09:16:49Z

Yes, readelf too. But the patches are in staging, so it would take awhile till they hit the channels.

oxij · 2018-08-24T11:20:10Z

Patches hit master recently. I think this should now be closed.

Profpatsch · 2018-09-05T15:56:01Z

Was reverted in c981787

Ericson2314 · 2018-09-05T16:30:20Z

:/

oxij · 2018-09-05T18:07:00Z

In c981787 and fa41297, to be precise. @edolstra, what exactly was not to your liking there? Reverting bugfixes without explanation isn't nice. Do you want `binutils-wrapper` to put docs into `propagated-user-env-packages` like `cc-wrapper` did (and does again after these reverts) or what? If yes, then why? I think symlinking is a cleaner solution, as, I think, wrappers should just reexport outputs of their inputs when possible. If Nixpkgs was SLNOS and SLNOS had centralized committer list like Nixpkgs I'd seriously think about removing you from that list after this and 4d1332e. Did either of those break anything?

oxij · 2018-09-05T18:50:53Z

Correction. There's also fde7296, so `bintools` already does the `propagated-user-env-packages` thing on master. I still don't understand why these changes were made, though. Please explain, @edolstra -sensei! I made #46115 with an edited revert. I think the first patch over master there needs to be reapplied again either way (unless it breaks something I'm not aware of) as that change did a useful and, I'd hope, non-controversial thing. The symlinking change is now a separate patch (which I still like).

edolstra · 2018-09-05T19:05:13Z

@oxij Don't worry, I have no desire to contribute to SLNOS.

Turning this around, I don't understand why these changes (moving from propagatedUserEnvPackages to symlinks) were made in the first place. Why are symlinks better?

Ericson2314 · 2018-09-05T19:07:22Z

@edolstra so nix-shell -p stdenv.cc.man works

edolstra · 2018-09-05T19:17:26Z

nix run stdenv.cc.man works (with Nix 2.1).

oxij · 2018-09-05T19:29:33Z

@edolstra

Don't worry, I have no desire to contribute to SLNOS.

My point is that a polite way do a revert of a recently discussed and accepted change is, at the very least, to make a PR and mention the author of the changes in question. I think that shooing PRs with "this needs mode discussion, hence this needs to go through RFC process" while commiting reverts straight to master without discussion is hypocrisy.

so `nix-shell -p stdenv.cc.man` works

That, and it also allows to control things directly via `outputsToInstall` which is used by `documentation` module of NixOS. Without the symlinking change that module can't do its thing for `environment.systemPackages = [ binutils gcc ];`

Ericson2314 · 2018-09-05T19:31:11Z

I can't get even nix run stdenv.cc.cc.man to work on whatever NixOS version I am on, so I am switching to a newer one.

oxij · 2018-09-05T19:49:13Z

Without the symlinking change that module can't do its thing for `environment.systemPackages = [ binutils gcc ];`

Correction. I checked and `buildEnv` does handle this indirection properly, so this argument is moot. So, I only have the following pros of symlinking left: - simpler, - uses 4 inodes less (two intermediate directories x2 for man and info), - direct references like "export MANPATH=${stdenv.cc.man}/share/man" simply work (which, I think, @Ericson2314 meant in the above).

Profpatsch · 2018-09-06T10:15:20Z

I opened a documentation request issue #46141. If we document these, tooling can add support to understand them (like nix 2.1 does).

oxij · 2018-09-06T13:36:45Z

So, a day and several hours of experiments later, I still think the correct way to proceed on the issue is to revert the reverts, i.e. merge #46115 as is (I also edited the reverted reverts a tiny bit there).

I wrote an explanation why the first patch of #46115 is the correct way to proceed on the issue in #46119 (comment) (also see the changes in #46119 to see the problem I didn't know I accidentally fixed it in #44558). Since I don't see any actual arguments against using symlinks, I think the second patch of #46115 should be applied too.

Hence, I would merge #46115 as is.

02c09e0 (NixOS#44558) was reverted in c981787 but, as it turns out, it fixed an issue I didn't know about at the time: the values of `propagateDoc` options were (and now again are) inconsistent with the underlying things those wrappers wrap (see NixOS#46119), which was (and now is) likely to produce more instances of NixOS#43547, if not now, then eventually as stdenv changes. This patch (which is a simplified version of the original reverted patch) is the simplest solution to this whole thing: it forces wrappers to directly inspect the outputs of the things they are wrapping instead of making stdenv guess the correct values.

oxij · 2019-02-18T21:29:00Z

This was fixed with #46115.

oxij mentioned this issue Aug 5, 2018

cc-wrapper: propagate man and info to propagated-build-inputs #44516

Merged

teto mentioned this issue Aug 6, 2018

manpages for clang/gcc #44531

Closed

oxij mentioned this issue Aug 6, 2018

stdenv: symlink propagated docs #44558

Merged

1 task

Ericson2314 closed this as completed Aug 24, 2018

Profpatsch reopened this Sep 5, 2018

oxij mentioned this issue Sep 5, 2018

cc-wrapper, bintools-wrapper: simply symlink man and info outputs #46115

Merged

3 tasks

oxij mentioned this issue Sep 5, 2018

bintools-wrapper, cc-wrapper: infer propagateDoc automatically #46119

Closed

oxij mentioned this issue Sep 23, 2018

treewide: mass rebuild noop cleanups #47233

Merged

3 tasks

Ericson2314 closed this as completed Jul 25, 2019

matthewbauer mentioned this issue Apr 21, 2020

darwin.binutils: propagate man pages from darwin.cctools #85653

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

binutils and gcc manpages hidden by wrappers #43547

binutils and gcc manpages hidden by wrappers #43547

bgamari commented Jul 15, 2018

bgamari commented Jul 15, 2018

infinisil commented Jul 17, 2018

matthewbauer commented Aug 1, 2018 •

edited

Loading

Ericson2314 commented Aug 2, 2018 •

edited

Loading

oxij commented Aug 3, 2018 via email

Ericson2314 commented Aug 3, 2018

oxij commented Aug 5, 2018

oxij commented Aug 8, 2018 via email

teto commented Aug 9, 2018

oxij commented Aug 9, 2018 via email

oxij commented Aug 24, 2018 via email

Profpatsch commented Sep 5, 2018

Ericson2314 commented Sep 5, 2018

oxij commented Sep 5, 2018 via email

oxij commented Sep 5, 2018 via email

edolstra commented Sep 5, 2018

Ericson2314 commented Sep 5, 2018

edolstra commented Sep 5, 2018

oxij commented Sep 5, 2018 via email

Ericson2314 commented Sep 5, 2018

oxij commented Sep 5, 2018 via email

Profpatsch commented Sep 6, 2018

oxij commented Sep 6, 2018

oxij commented Feb 18, 2019 via email

binutils and gcc manpages hidden by wrappers #43547

binutils and gcc manpages hidden by wrappers #43547

Comments

bgamari commented Jul 15, 2018

Issue description

Steps to reproduce

Technical details

bgamari commented Jul 15, 2018

infinisil commented Jul 17, 2018

matthewbauer commented Aug 1, 2018 • edited Loading

Ericson2314 commented Aug 2, 2018 • edited Loading

oxij commented Aug 3, 2018 via email

Ericson2314 commented Aug 3, 2018

oxij commented Aug 5, 2018

oxij commented Aug 8, 2018 via email

teto commented Aug 9, 2018

oxij commented Aug 9, 2018 via email

oxij commented Aug 24, 2018 via email

Profpatsch commented Sep 5, 2018

Ericson2314 commented Sep 5, 2018

oxij commented Sep 5, 2018 via email

oxij commented Sep 5, 2018 via email

edolstra commented Sep 5, 2018

Ericson2314 commented Sep 5, 2018

edolstra commented Sep 5, 2018

oxij commented Sep 5, 2018 via email

Ericson2314 commented Sep 5, 2018

oxij commented Sep 5, 2018 via email

Profpatsch commented Sep 6, 2018

oxij commented Sep 6, 2018

oxij commented Feb 18, 2019 via email

matthewbauer commented Aug 1, 2018 •

edited

Loading

Ericson2314 commented Aug 2, 2018 •

edited

Loading