lix/doc/manual
jade b62cc7b361 meson: prepare for include rearrangement
Context: we have include paths that are "types.hh" and similarly common
names. We currently have these compatibly available as
"lix/libutil/types.hh" externally but *not yet internally*. This is
because we don't have any way for the src directory to appear as
`"lix/"` from inside of Lix: the lix/ include directory is created by
the install process.

The goal of this whole thing is to make it clearer which component of
Lix that files are a part of, which should hopefully help at least a
little bit to new developers. One disadvantage of un-mixing these is
that it will cause some API changes if we ever move a file between
libraries, but that is not very common, and we don't care that much
about external API users.

This was planned for a while and is why we have a FixIncludes check to
begin with.

Personally I don't see a great benefit in rearranging our source code,
and in fact, it would probably be counterproductive:
- Moving the includes into a separate `include/` directory would just
  make developers have to deal with more directories, when we can
  already generate the desired layout through the build process.
- This would also decouple the .cc and .hh files which currently
  conventionally have each others' definitions and declarations
  respectively, right next to each other, making it easier for them to
  feel decoupled and diverge.

Content: Add ../include as an include directory so that lix/ in include
paths will resolve to src/ within Lix itself, just as it does externally
today. This prepares for a further series of commits applying the actual
change to each library one-by-one by accepting both include versions at
once.

This could have been done with ../ and a symlink called lix, but we
would like to not accept libexpr/foo.hh internally for it would be
broken externally, so we need an otherwise empty directory for the
include.

Change-Id: Ideac17faadae2bcea2dffbab34eb27c582ede399
2024-11-18 12:22:39 -08:00
..
rl-next meson: prepare for include rearrangement 2024-11-18 12:22:39 -08:00
src libexpr: generate builtins from data 2024-11-09 16:17:26 +01:00
theme Add pre-commit checks 2024-03-29 22:57:40 -07:00
anchors.jq Add pre-commit checks 2024-03-29 22:57:40 -07:00
book.toml docs: enable non-default TOC folding 2024-05-30 00:23:01 +00:00
change-authors.yml Merge "fix(libfetchers): set GitHub API version header, closes #255" into main 2024-11-05 22:44:29 +00:00
custom.css disallow selecting shell prompt in code samples 2022-12-05 11:01:46 +01:00
generate-builtin-constants.nix Format Nix code with nixfmt 2024-04-08 13:00:00 -07:00
generate-builtins.nix Format Nix code with nixfmt 2024-04-08 13:00:00 -07:00
generate-deps.py docs: redo content generation for mdbook and manual 2024-04-11 13:32:06 +00:00
generate-manpage.nix docs: don't compute SUMMARY.md during build 2024-04-09 02:09:36 +00:00
json-to-tree.py docs: generalize manpage generation script as json-to-tree.py 2024-04-10 15:04:34 +02:00
meson.build libexpr: generate builtins from data 2024-11-09 16:17:26 +01:00
process-includes.sh change shebangs of all .sh scripts to bash 2024-06-24 14:00:43 -07:00
quote-literals.xsl
rclone.conf doc: add a script to upload the nightly manual manually 2024-05-14 14:28:01 -07:00
redirects.js manual: fix a syntax error in redirects.js that made it not do anything 2024-08-04 20:41:19 -07:00
render-manpage.sh change shebangs of all .sh scripts to bash 2024-06-24 14:00:43 -07:00
substitute.py docs: redo content generation for mdbook and manual 2024-04-11 13:32:06 +00:00
utils.nix Format Nix code with nixfmt 2024-04-08 13:00:00 -07:00