[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] main 3d5d6ee 1/4: * README (Directory layout): Update with change
From: |
Jonas Bernoulli |
Subject: |
[elpa] main 3d5d6ee 1/4: * README (Directory layout): Update with changes from elpa-admin branch. |
Date: |
Wed, 20 Oct 2021 18:49:12 -0400 (EDT) |
branch: main
commit 3d5d6ee620880edc12ea3d89acbd97e0ec0827f6
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>
* README (Directory layout): Update with changes from elpa-admin branch.
---
README | 22 +++++++++++++++++-----
1 file changed, 17 insertions(+), 5 deletions(-)
diff --git a/README b/README
index ed0ed1e..99d3db7 100644
--- a/README
+++ b/README
@@ -55,11 +55,23 @@ checkout, you can update it like this:
* Directory layout
-** =admin/= -- scripts for administering the package archive.
-** =html/= -- HTML for the elpa.gnu.org website.
-** =packages/= -- source code for the packages.
-** =archive/= -- destination of the release tarballs built.
-** =archive-devel/= -- destination of the snapshot tarballs built.
+This code expects to be used in a directory that has the following layout:
+
+- =admin/= -- Directory containing a copy of the here files
+- =GNUmakefile= -- A copy of or symlink to =admin/GNUmakefile=
+- =elpa-packages= -- The specifications of the packages
+- =elpa-config= -- Some configuration settings for the build scripts
+- =copyright_exceptions= -- List of exceptions for the copyright-notices checks
+
+The =copyright_exceptions= file can be absent, in which case copyright notices
+will simply not be checked.
+
+Additionally to the above, this code will then add to that directory
+the following elements:
+
+- =packages/= -- Directory holding Git worktrees of packages
+- =archive/= -- Directory holding the generated files for the
archive
+- =archive-devel/= -- Same for the "bleeding edge" version of the archive
* Packages