Alexander Bantyev
36b059748d
Split nix-env and nix-store documentation per-subcommand
...
Documentation on "classic" commands with many sub-commands are
notoriously hard to discover due to lack of overview and anchor links.
Additionally the information on common options and environment variables
is not accessible offline in man pages, and therefore often overlooked
by readers.
With this change, each sub-command of nix-store and nix-env gets its
own page in the manual (listed in the table of contents), and each own
man page.
Also, man pages for each subcommand now (again) list common options
and environment variables. While this makes each page quite long and
some common parameters don't apply, this should still make it easier
to navigate as that additional information was not accessible on the
command line at all.
It is now possible to run 'nix-store --<subcommand> --help` to display
help pages for the given subcommand.
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-03-30 09:46:28 +02:00
Alexander Bantyev
84c2c09ec2
Manual: fail when #include-d file does not exist
2023-03-30 09:41:46 +02:00
Eelco Dolstra
10dc2e2e7c
Merge pull request #8125 from vaci/vaci/hash_to_string_copy
...
Avoid a string copy during Hash::to_string
2023-03-29 12:27:35 +02:00
Vaci Koblizek
a4dd87a2b3
avoid a string copy in printHash16
2023-03-29 10:54:27 +01:00
Vaci Koblizek
ccf7ce26fe
return string_view from printHashType rather than string
2023-03-29 10:44:22 +01:00
Vaci Koblizek
957f832074
Avoid a string copy during Hash::to_string
2023-03-28 17:20:33 +01:00
John Ericson
56dc6ed841
Merge pull request #8114 from obsidiansystems/docs-profiles-dirs
...
Fix more profile dirs in docs
2023-03-27 16:35:49 -04:00
John Ericson
8df6f7bb0f
Fix more profile dirs in docs
...
Picking up where #8078 left off.
2023-03-27 12:10:32 -04:00
Eelco Dolstra
5e3f855526
Merge pull request #7763 from obsidiansystems/installable-wide-info
...
Stratify `ExtraPathInfo` along `Installable` hierarchy
2023-03-27 17:04:08 +02:00
Eelco Dolstra
237587bc0a
Merge pull request #8084 from edolstra/store-docs
...
Auto-generate store documentation
2023-03-27 15:46:18 +02:00
John Ericson
1d539aa287
Merge pull request #8073 from tweag/fix-root-channels-location
...
Fix root channels location
2023-03-27 09:37:53 -04:00
Eelco Dolstra
5a0f5b5c34
Merge pull request #8062 from edolstra/ssl-cert-file
...
Add a setting for configuring the SSL certificates file
2023-03-27 15:37:15 +02:00
John Ericson
570829d67e
Merge pull request #7609 from obsidiansystems/hide-experimental-settings
...
Hide experimental settings
2023-03-27 09:19:29 -04:00
Eelco Dolstra
a519436e9d
ssl-cert-file: Use lists
2023-03-27 14:08:39 +02:00
Eelco Dolstra
2523448bad
Merge pull request #8104 from avdv/graphml-use-long-for-narsize
...
nix-store: Use `long` for `narSize` in graphml output
2023-03-27 13:10:28 +02:00
Théophane Hufschmitt
128994509f
Make some comments in profiles.hh doxygen-enabled
...
These are proper documentation of the API, so they deserve to be here
2023-03-27 10:02:10 +02:00
Robert Hensing
9e7940e35d
Merge pull request #8109 from oxalica/fix/show-legacy-packages
...
Catch eval errors in `hasContent`
2023-03-27 05:46:49 +02:00
Robert Hensing
6b87c6577f
tests/flakes/show.sh: Broaden requirement comment
2023-03-27 05:11:23 +02:00
oxalica
2941a599fa
Catch eval errors in hasContent
...
`legacyPackages` of nixpkgs trigger eval errors in `hasContent`, causing
the whole `legacyPackages` being skipped. We should treat it as
has-content in that case.
2023-03-26 23:05:29 +08:00
Claudio Bley
e7b9dc7c89
nix-store: Use long
for narSize
in graphml output
2023-03-24 17:25:17 +01:00
John Ericson
256f3e3063
Stratify ExtraPathInfo
along Installable
hierarchy
...
Instead of having a bunch of optional fields, have a few subclasses
which can have mandatory fields.
Additionally, the new `getExtraPathInfo`, and `nixpkgsFlakeRef`, are
moved to `InstallableValue`.
I did these things because https://github.com/NixOS/rfcs/pull/134 ; with
these things moved to `InstallableValue`, the base `Installable` no
longer depends on libexpr! This is a major step towards that.
Also, add a bunch of doc comments for sake of the internal API docs.
2023-03-24 12:22:40 -04:00
Eelco Dolstra
e00abd3f56
Merge pull request #7757 from obsidiansystems/more-installable-value
...
Move value-only methods to `InstallableValue`
2023-03-24 14:07:18 +01:00
Théophane Hufschmitt
a4c2cd3c06
Merge pull request #8098 from hercules-ci/error-cc-Only-suggest-show-trace-when-truncated-trace-items-would-be-pri
...
error.cc: Only suggest `--show-trace` when relevant
2023-03-24 12:07:44 +01:00
Théophane Hufschmitt
eed43de02f
Merge pull request #8096 from tweag/filter-tests
...
Filter tests/nixos from source
2023-03-24 12:06:26 +01:00
Alexander Bantyev
80f9231b69
Filter tests/nixos from source
2023-03-24 14:29:28 +04:00
Théophane Hufschmitt
717e81df13
Test the installation of a simple package in the install tests
2023-03-23 21:58:59 +01:00
Robert Hensing
233c4cf30f
error.cc: Only suggest show-trace when truncated trace items would be printed
...
Otherwise, a trace consisting of
frame
frame
frame
non-frame
... would reach the non-frame and print the suggestion, even though
it would have ignored the non-frame anyway.
This resulted in a peculariar situation where --show-trace would have
no apparent effect, as the trace was actually already complete.
2023-03-23 17:29:06 +01:00
Eelco Dolstra
168b6021c5
Tweaks
2023-03-23 15:32:59 +01:00
Eelco Dolstra
7a61a9aba3
Update release notes
2023-03-23 15:27:06 +01:00
Eelco Dolstra
b79df9dedc
Register LocalStore to ensure it's included in the manual
2023-03-23 15:23:13 +01:00
Eelco Dolstra
161f4b0dea
Document store URLs
2023-03-23 10:38:48 +01:00
Théophane Hufschmitt
cff3149a01
ci: Update the install-nix-action
2023-03-23 10:22:42 +01:00
Théophane Hufschmitt
fb67c1a1fb
Factor out the generation of the profile/channel directory
...
Make sure that all the code paths use the same one, and that the
backwards-compatibility measures are probably in place when needed
2023-03-23 10:22:42 +01:00
Théophane Hufschmitt
82bd9535dd
nix-channel: Restore the old root channels directory
2023-03-23 10:22:42 +01:00
Théophane Hufschmitt
918ca8b3a3
ci: Try to install something with Nix in the installer test
2023-03-23 10:22:42 +01:00
Eelco Dolstra
05d9918a9c
Update doc/manual/src/release-notes/rl-next.md
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-03-23 10:13:51 +01:00
Eelco Dolstra
abc449bc30
Update src/libstore/local-store.md
...
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-03-23 10:12:57 +01:00
Eelco Dolstra
4d31618c15
showSetting: Drop ...
2023-03-23 10:09:25 +01:00
Eelco Dolstra
2851e239a7
Make useAnchors a named argument
2023-03-23 10:08:49 +01:00
Eelco Dolstra
80f0b8d307
Fix SSHStore
2023-03-23 09:35:35 +01:00
Eelco Dolstra
fbc296e00f
Merge pull request #8095 from fricklerhandwerk/operators-formatting
...
doc: force line breaks where needed
2023-03-23 09:24:54 +01:00
Eelco Dolstra
b134546f08
Fix clang build
2023-03-23 09:11:15 +01:00
John Ericson
e5146a6a50
Merge pull request #8078 from obsidiansystems/profile-md
...
Fix `nix profile --help`
2023-03-22 19:36:12 -04:00
Valentin Gagarin
0ced5132fd
Merge pull request #6865 from zuzuleinen/manual-nix-path-empty
...
document what happens when NIX_PATH is empty
2023-03-23 00:10:17 +01:00
Valentin Gagarin
96129246ad
add links
2023-03-22 23:37:27 +01:00
Valentin Gagarin
40eb88e427
doc: force line breaks where needed
2023-03-22 22:46:23 +01:00
Alex Wied
6dbce3215f
docker.nix: add an option to include flake-registry inside docker image ( #6750 )
...
Co-authored-by: Alex Wied <centromere@users.noreply.github.com>
Co-authored-by: Rok Garbas <rok@floxdev.com>
2023-03-22 20:55:02 +01:00
Eelco Dolstra
5691bac202
Improve store setting descriptions / Markdown formatting
2023-03-22 14:23:36 +01:00
Eelco Dolstra
da8903ecc3
nix help-stores: Don't include anchors
...
Since setting names are not unique we don't have an easy way to
produce unique anchors.
2023-03-22 13:11:35 +01:00
Eelco Dolstra
006291e5be
Merge pull request #8082 from edolstra/add-links
...
Add links to API docs / coverage analysis to the hacking section
2023-03-22 11:27:18 +01:00