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

nixos/documentation: nixos-help: use w3m(1) by default #62891

Conversation

jtojnar
Copy link
Contributor

@jtojnar jtojnar commented Jun 9, 2019

Sent by Discourse: https://discourse.nixos.org/t/nixos-documentation-nixos-help-use-w3m-1-by-default/3124


Motivation for this change

It is referenced in various places, but does not work out of the box:

$ nixos-help
/run/current-system/sw/bin/nixos-help: unable to start a web browser; please set $BROWSER

In the user-hidden fallbacks to xdg-open(1) and w3m(1), nixos-help
expects tools to be deliberately installed by users.

For default installations and new users in general, this is unlikely to
be the case. Conversely, chances to use nixos-help are even higher
in such cases.

Use w3m-nographics by default to ensure documentation is always
available. The documentation browser on ttyS8 already does so, but is
not accessible in every installation, e.g. VMs with only ttyS0 and SSH
available.

This obsoletes including it in the base profile's systemPackages,
so remove the @todo as done.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nix-review --run "nix-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@nixos-discourse
Copy link

This pull request has been mentioned on Nix community. There might be relevant details there:

https://discourse.nixos.org/t/nixos-documentation-nixos-help-use-w3m-1-by-default/3124/6

@nixos-discourse
Copy link

This pull request has been mentioned on Nix community. There might be relevant details there:

https://discourse.nixos.org/t/nixos-documentation-nixos-help-use-w3m-1-by-default/3124/7

It is referenced in various places, but does not work out of the box:

	$ nixos-help
	/run/current-system/sw/bin/nixos-help: unable to start a web browser; please set $BROWSER

In the user-hidden fallbacks to xdg-open(1) and w3m(1), `nixos-help`
expects tools to be deliberately installed by users.

For default installations and new users in general, this is unlikely to
be the case.  Conversely, chances to use `nixos-help` are even higher
in such cases.

Use w3m-nographics by default to ensure documentation is always
available.  The documentation browser on ttyS8 already does so, but is
not accessible in every installation, e.g. VMs with only ttyS0 and SSH
available.

This obsoletes including it in the base profile's systemPackages,
so remove the @todo as done.
@jtojnar jtojnar force-pushed the nixos-documentation-nixos-help-use-w3m-1-by-default branch from 59451f1 to 03d6c40 Compare June 9, 2019 15:12
@matthewbauer matthewbauer merged commit 9d9b98c into NixOS:master Jun 23, 2019
@jtojnar jtojnar deleted the nixos-documentation-nixos-help-use-w3m-1-by-default branch August 20, 2019 12:55
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

5 participants