From 2628c68fa91c35ce7b9cfb1e637fd397dda6621f Mon Sep 17 00:00:00 2001 From: Jonas Bernoulli Date: Sat, 3 Aug 2024 19:09:24 +0200 Subject: [PATCH] docs: Mention that init-tangle target has to be run explicitly Closes #162. --- docs/borg.org | 7 ++++++- docs/borg.texi | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/borg.org b/docs/borg.org index c1a6071..2b4fe79 100644 --- a/docs/borg.org +++ b/docs/borg.org @@ -748,7 +748,12 @@ those are the drones that take longer to build. - Command: init-tangle :: This target tangles (creates) ~init.el~ from ~init.org~. You obviously - don't have to use such a file if you don't want to. + don't have to use such a file, if you don't want to. + + Note that this target is *not* a dependency of ~init-build~, because it + necessarily has to depend on ~init.org~, which for most people does + not exist. So you have to run this target explicitly after making + changes to ~init.org~. - Command: init-build :: diff --git a/docs/borg.texi b/docs/borg.texi index 3d178fc..f373d8e 100644 --- a/docs/borg.texi +++ b/docs/borg.texi @@ -830,7 +830,12 @@ This target removes byte-code files for init files. @deffn Command init-tangle This target tangles (creates) @code{init.el} from @code{init.org}. You obviously -don't have to use such a file if you don't want to. +don't have to use such a file, if you don't want to. + +Note that this target is @strong{not} a dependency of @code{init-build}, because it +necessarily has to depend on @code{init.org}, which for most people does +not exist. So you have to run this target explicitly after making +changes to @code{init.org}. @end deffn @deffn Command init-build