summaryrefslogtreecommitdiff
path: root/Master/tlpkg/doc
diff options
context:
space:
mode:
authorNorbert Preining <preining@logic.at>2010-05-17 02:10:56 +0000
committerNorbert Preining <preining@logic.at>2010-05-17 02:10:56 +0000
commit4eb343fe6ec0cfe6e868ea717e604b65e795dcb9 (patch)
treee0fc54c14dc91278bc84e4b78e2fc4582d497596 /Master/tlpkg/doc
parent2fe2a2ad57334001b2bd5abb4cb0e8cafcc8343a (diff)
add -tlpdb-options-from-tlpsrc to tl-update-tlpdb and document everything
in repository-setup.txt git-svn-id: svn://tug.org/texlive/trunk@18296 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/tlpkg/doc')
-rw-r--r--Master/tlpkg/doc/repository-setup.txt40
1 files changed, 29 insertions, 11 deletions
diff --git a/Master/tlpkg/doc/repository-setup.txt b/Master/tlpkg/doc/repository-setup.txt
index adfded61e32..b6d52177848 100644
--- a/Master/tlpkg/doc/repository-setup.txt
+++ b/Master/tlpkg/doc/repository-setup.txt
@@ -100,36 +100,51 @@ and place them into
You have to have ONE .tlpsrc file for each package you want to ship, and
furthermore ONE for your overall installation, called
-00texlive.config.tlpsrc. This should contain (at least) the following
-lines:
+00texlive.config.tlpsrc. This package defines some basic configurations
+for the tlpdb, like how it announces itself, whether separate src and
+doc containers are build, and the release years it supports.
+
+By default these values are taken from %TeXLive::TLConfig::TLPDBConfigs
+where you can make changes in your local TLConfig.pm file, or you add
+these settings directly in the tlpsrc file and call tl-update-tlpdb
+later on with the option -tlpdb-options-from-tlpsrc.
+
+In the end the generate "package" 00texlive.config should contain
+(at least) the following lines:
category TLCore
- depend container_split_src_files
- depend container_split_doc_files
depend container_format/xz
depend release/NNNN-YOUR_ID
+
+and might optionally contain:
+ depend container_split_src_files
+ depend container_split_doc_files
depend maxrelease/MMMM-YOUR_ID
+The
+ depend container_format/xz
+is *obligatory* because currently we do NOT support any other format.
+
The "container_split_src_files" and "container_split_doc_files" are
options, they specify whether at a later stage the container script will
generate separate .tar.xz archives for source and doc files, or put
all of them into one .tar.xz. It is up to you.
-The
- depend container_format/xz
-is *obligatory* because currently we do NOT support any other format.
-
Finally, the
depend release/NNNN-YOUR_ID
+and (optionally)
depend maxrelease/MMMM-YOUR_ID
determine(s) which release(s) of TL your repository works with.
-If maxrelease is present, the year specified in $TLConfig::ReleaseYear
-must be in the range [release,maxrelease]. Otherwise the release/NNNN
-value must exactly match the the TL release number NNNN.
+If maxrelease is present, the year specified in the local (user's)
+installation's $TLConfig::ReleaseYear must be in the range
+[release,maxrelease].
+If maxrelease is not present, the release/NNNN value must exactly
+match the the TL release number NNNN.
For example, you might have:
depend release/2009-myorg
and if your packages work with both TL'09 and TL'10, you could add:
depend maxrelease/2010-myorg
+
For the rest of your package you should create .tlpsrc files describing
their content. Either copy one of our .tlpsrc files, or (much better)
PLEASE read the documentation of TLPSRC.pm (in POD format).
@@ -156,6 +171,9 @@ the TLPSRC.pm documentation (and don't forget to copy
If you have set up all your local files, and the tlpsrc files, you can
create the TeX Live Database in ROOT/tlpkg/texlive.tlpdb by calling
perl ROOT/tlpkg/bin/tl-update-tlpdb -from-files
+If you have set your TLPDB configuration options directly in the .tlpsrc
+file you have to add
+ -tlpdb-options-from-tlpsrc
The -from-files does use a find command to find all the files in ROOT
instead of using "svn status" what is done normally. By default
tl-update-tlpdb uses all tlpsrc files present in ROOT/tlpkg/tlpsrc/.