Nix/src/libstore
Valentin Gagarin 4781e7fa70 Document each store type on its own page
This makes for more useful manual table of contents, that displays the
information at a glance.

The `nix help-stores` command is kept as-is, even though it will show up
in the manual with the same information as these pages due to the way it
is written as a "`--help`-style" command. Deciding what to do with that
command is left for a later PR.

This change also lists all store types at the top of the respective overview page.

Co-authored-by: John Ericson <John.Ericson@Obsidian.Systems
2023-12-01 01:27:52 +01:00
..
build Put canonicaliseTimestampAndPermissions in its own header/file 2023-11-21 12:57:59 -05:00
builtins Fix signed vs. unsigned comparison warning and improve code 2023-10-24 19:57:38 +02:00
tests Allow installing unit tests 2023-11-16 09:55:42 -05:00
binary-cache-store.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
binary-cache-store.hh Merge FSAccessor into SourceAccessor 2023-11-01 17:09:28 +01:00
build-result.cc Test the rest of the worker protocol serializers 2023-10-04 15:31:52 -04:00
build-result.hh Test the rest of the worker protocol serializers 2023-10-04 15:31:52 -04:00
builtins.hh Ensure all headers have #pragma once and are in API docs 2023-03-31 23:19:44 -04:00
ca-specific-schema.sql ca: add sqlite index on RealisationsRefs(realisationReference) 2022-04-21 10:06:39 +02:00
common-protocol-impl.hh Factor out bits of the worker protocol to use elsewhere 2023-10-09 16:55:12 -04:00
common-protocol.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
common-protocol.hh Factor out bits of the worker protocol to use elsewhere 2023-10-09 16:55:12 -04:00
content-address.cc Fix warning 2023-10-24 19:57:38 +02:00
content-address.hh Persistently cache InputAccessor::fetchToStore() 2023-11-20 20:04:37 +01:00
crypto.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
crypto.hh Finish converting existing comments for internal API docs (#8146) 2023-04-07 13:55:28 +00:00
daemon.cc Extend the worker protocol with wopAddPermRoot 2023-11-21 13:26:55 -05:00
daemon.hh Add Store::isTrustedClient() 2023-04-06 19:59:57 -04:00
derivations.cc Remove all the occurences of VLAs 2023-11-16 12:27:30 +01:00
derivations.hh Allow dynamic derivation deps in inputDrvs 2023-09-07 10:39:37 -04:00
derived-path-map.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
derived-path-map.hh Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
derived-path.cc Introduce OutputName and OutputNameView type aliases 2023-08-25 09:55:07 -04:00
derived-path.hh Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
downstream-placeholder.cc treewide: Reference HashFormat members with scope 2023-10-19 00:56:41 +08:00
downstream-placeholder.hh Introduce OutputName and OutputNameView type aliases 2023-08-25 09:55:07 -04:00
dummy-store.cc Merge FSAccessor into SourceAccessor 2023-11-01 17:09:28 +01:00
dummy-store.md Support per-store Markdown documentation 2023-03-21 14:03:40 +01:00
export-import.cc Make ParseSink a bit better 2023-11-01 02:36:43 -04:00
filetransfer.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
filetransfer.hh Allow tarball URLs to redirect to a lockable immutable URL 2023-06-13 14:17:45 +02:00
gc-store.hh Clean up store hierarchy with IndirectRootStore 2023-07-24 09:19:44 -04:00
gc.cc readProcLink: Replace unnecessary value judgement by actual info 2023-11-16 15:38:21 +01:00
globals.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
globals.hh Document each store type on its own page 2023-12-01 01:27:52 +01:00
http-binary-cache-store.cc Add Store::isTrustedClient() 2023-04-06 19:59:57 -04:00
http-binary-cache-store.md Support per-store Markdown documentation 2023-03-21 14:03:40 +01:00
indirect-root-store.hh MountedSSHStore: stores on shared filesystems 2023-11-21 13:34:01 -05:00
legacy-ssh-store.cc Merge FSAccessor into SourceAccessor 2023-11-01 17:09:28 +01:00
legacy-ssh-store.md Support per-store Markdown documentation 2023-03-21 14:03:40 +01:00
length-prefixed-protocol-helper.hh Factor out bits of the worker protocol to use elsewhere 2023-10-09 16:55:12 -04:00
local-binary-cache-store.cc Add Store::isTrustedClient() 2023-04-06 19:59:57 -04:00
local-binary-cache-store.md Support per-store Markdown documentation 2023-03-21 14:03:40 +01:00
local-fs-store.cc LocalStoreAccessor: Reuse PosixSourceAccessor 2023-11-01 17:22:25 +01:00
local-fs-store.hh Merge FSAccessor into SourceAccessor 2023-11-01 17:09:28 +01:00
local-store.cc Improve ACL clearing support (fixing FreeBSD build) 2023-11-29 21:09:19 -05:00
local-store.hh Put canonicaliseTimestampAndPermissions in its own header/file 2023-11-21 12:57:59 -05:00
local-store.md Tweaks 2023-03-23 15:32:59 +01:00
local.mk Use buildprefix in a few more places 2023-11-29 19:49:07 -05:00
lock.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
lock.hh Finish converting existing comments for internal API docs (#8146) 2023-04-07 13:55:28 +00:00
log-store.cc Move the getBuildLog implementation to its own implementation file 2023-01-13 11:05:44 +01:00
log-store.hh Finish converting existing comments for internal API docs (#8146) 2023-04-07 13:55:28 +00:00
machines.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
machines.hh Ensure all headers have #pragma once and are in API docs 2023-03-31 23:19:44 -04:00
make-content-addressed.cc Merge pull request #8650 from obsidiansystems/content-address-simpler 2023-07-21 13:46:53 +02:00
make-content-addressed.hh makeContentAddressed: Add single path helper 2023-06-30 18:22:47 +02:00
misc.cc Allow dynamic derivation deps in inputDrvs 2023-09-07 10:39:37 -04:00
mounted-ssh-store.md MountedSSHStore: stores on shared filesystems 2023-11-21 13:34:01 -05:00
names.cc return string_views from forceString* 2022-01-27 17:15:43 +01:00
names.hh Ensure all headers have #pragma once and are in API docs 2023-03-31 23:19:44 -04:00
nar-accessor.cc Fix consts and casts 2023-11-08 17:29:55 +01:00
nar-accessor.hh Fix consts and casts 2023-11-08 17:29:55 +01:00
nar-info-disk-cache.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
nar-info-disk-cache.hh Finish converting existing comments for internal API docs (#8146) 2023-04-07 13:55:28 +00:00
nar-info.cc Fix consts and casts 2023-11-08 17:29:55 +01:00
nar-info.hh Fix consts and casts 2023-11-08 17:29:55 +01:00
nix-store.pc.in Fix building with GCC 9 2023-02-10 18:38:57 +01:00
optimise-store.cc Put canonicaliseTimestampAndPermissions in its own header/file 2023-11-21 12:57:59 -05:00
outputs-spec.cc Fix moves that accidentally copy anyway 2023-10-16 21:48:35 +01:00
outputs-spec.hh Introduce OutputName and OutputNameView type aliases 2023-08-25 09:55:07 -04:00
parsed-derivations.cc Make nix path-info --json return an object not array 2023-11-06 11:06:31 -05:00
parsed-derivations.hh Ensure all headers have #pragma once and are in API docs 2023-03-31 23:19:44 -04:00
path-info.cc Make nix path-info --json return an object not array 2023-11-06 11:06:31 -05:00
path-info.hh Make nix path-info --json return an object not array 2023-11-06 11:06:31 -05:00
path-references.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
path-references.hh Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
path-regex.hh StorePath: reject names starting with '.' 2023-10-04 22:10:52 +00:00
path-with-outputs.cc Fixing #7479 2023-08-18 11:44:00 -04:00
path-with-outputs.hh Make the Derived Path family of types inductive for dynamic derivations 2023-08-10 00:08:32 -04:00
path.cc treewide: Reference HashFormat members with scope 2023-10-19 00:56:41 +08:00
path.hh Ensure all headers have #pragma once and are in API docs 2023-03-31 23:19:44 -04:00
pathlocks.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
pathlocks.hh Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
posix-fs-canonicalise.cc Improve ACL clearing support (fixing FreeBSD build) 2023-11-29 21:09:19 -05:00
posix-fs-canonicalise.hh Put canonicaliseTimestampAndPermissions in its own header/file 2023-11-21 12:57:59 -05:00
profiles.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
profiles.hh Clean up a few things related to profiles (#8526) 2023-06-19 04:04:59 +00:00
realisation.cc libstore: also pass unwanted outputs to the post-build-hook 2023-05-08 12:58:59 +02:00
realisation.hh treewide: Reference HashFormat members with scope 2023-10-19 00:56:41 +08:00
remote-fs-accessor.cc Merge FSAccessor into SourceAccessor 2023-11-01 17:09:28 +01:00
remote-fs-accessor.hh Merge FSAccessor into SourceAccessor 2023-11-01 17:09:28 +01:00
remote-store-connection.hh Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
remote-store.cc Document each store type on its own page 2023-12-01 01:27:52 +01:00
remote-store.hh Merge FSAccessor into SourceAccessor 2023-11-01 17:09:28 +01:00
repair-flag.hh Ensure all headers have #pragma once and are in API docs 2023-03-31 23:19:44 -04:00
s3-binary-cache-store.cc Remove bug-avoiding StoreConfig * casts for settings 2023-10-31 12:09:46 -04:00
s3-binary-cache-store.hh Ensure all headers have #pragma once and are in API docs 2023-03-31 23:19:44 -04:00
s3-binary-cache-store.md Merge how-to section on S3 buckets into S3 store docs (#7972) 2023-10-23 13:22:33 -04:00
s3.hh Ensure all headers have #pragma once and are in API docs 2023-03-31 23:19:44 -04:00
schema.sql schema.sql: add comment about hash being in base16 2022-06-01 14:59:57 +02:00
serve-protocol-impl.hh Introduce separate Serve protocol serialisers 2023-10-10 11:52:45 -04:00
serve-protocol.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
serve-protocol.hh Factor out serialization for BuildResult 2023-10-20 15:19:28 -04:00
sqlite.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
sqlite.hh Support opening local store with database on read-only filesystem (#8356) 2023-06-20 11:34:09 +02:00
ssh-store-config.hh Document each store type on its own page 2023-12-01 01:27:52 +01:00
ssh-store.cc MountedSSHStore: stores on shared filesystems 2023-11-21 13:34:01 -05:00
ssh-store.md Support per-store Markdown documentation 2023-03-21 14:03:40 +01:00
ssh.cc fix(ssh): log first line of stdout 2023-11-06 08:46:19 -05:00
ssh.hh Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
store-api.cc Shuffle ValidPathInfo JSON rendering 2023-11-06 11:06:31 -05:00
store-api.hh Document each store type on its own page 2023-12-01 01:27:52 +01:00
store-cast.hh Ensure all headers have #pragma once and are in API docs 2023-03-31 23:19:44 -04:00
uds-remote-store.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
uds-remote-store.hh Merge FSAccessor into SourceAccessor 2023-11-01 17:09:28 +01:00
uds-remote-store.md Support per-store Markdown documentation 2023-03-21 14:03:40 +01:00
worker-protocol-impl.hh Factor out bits of the worker protocol to use elsewhere 2023-10-09 16:55:12 -04:00
worker-protocol.cc Fix consts and casts 2023-11-08 17:29:55 +01:00
worker-protocol.hh Extend the worker protocol with wopAddPermRoot 2023-11-21 13:26:55 -05:00