diff options
author | Norbert Preining <preining@logic.at> | 2018-03-08 08:10:07 +0000 |
---|---|---|
committer | Norbert Preining <preining@logic.at> | 2018-03-08 08:10:07 +0000 |
commit | 5a2f0cfcaa3cf803e5c9c49d1180df4a221e5f73 (patch) | |
tree | c8a5a788c4f6de547ca7d6fa20771f5a7b3ac5c5 /Master/tlpkg/doc | |
parent | 55adc615d81723b7f3da4d6d4f4995fc0aae401a (diff) |
more improvements for repository-setup doc
git-svn-id: svn://tug.org/texlive/trunk@46888 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/tlpkg/doc')
-rw-r--r-- | Master/tlpkg/doc/repository-setup.txt | 37 |
1 files changed, 27 insertions, 10 deletions
diff --git a/Master/tlpkg/doc/repository-setup.txt b/Master/tlpkg/doc/repository-setup.txt index 68ed85614ea..ae5a89f16cb 100644 --- a/Master/tlpkg/doc/repository-setup.txt +++ b/Master/tlpkg/doc/repository-setup.txt @@ -61,6 +61,13 @@ distribution database in Finally you create/update your web distribution from that ROOT. +The repository can then be used either on a one-time basis with + tlmgr --repository URL-of-your-repo <action> +or by permanently adding it to the used repositories with + tlmgr repository add URL-of-your-repo <tagname> +Please see the documentation of tlmgr (tlmgr -help or man tlmgr) for +details. + 1. Prerequisites ---------------- @@ -73,8 +80,8 @@ We recommend svn, so that you can easily update them regularly. Note that it is not necessary to have the above files and the files you are distributing in the same file hierarchy. It is completely valid -to have a full checkout of TeX Live (svn or git) and use the scripts -from there. See Section 9 for an example management script. +to have a full or partial checkout of TeX Live (svn or git) and use +the scripts from there. See Section 9 for an example management script. @@ -93,6 +100,8 @@ You will have to deal with two different folders on your system: NETROOT In TeX Live this would be the 'tlnet' folder. +Note that ROOT and NETROOT should be different! + Put all of YOUR files in a TDS compliant way into the texmf-dist folder: ROOT/texmf-dist Usage of 'texmf' as tree is strongly discouraged but still possible. @@ -131,8 +140,8 @@ In the end the generate "package" 00texlive.config should contain depend release/NNNN-YOUR_ID and might optionally contain: - depend container_split_src_files - depend container_split_doc_files + depend container_split_src_files/1 + depend container_split_doc_files/1 depend minrelease/MMMM-YOUR_ID The @@ -142,7 +151,9 @@ 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. +all of them into one .tar.xz. It is up to you. TeX Live uses splitting +of src and doc files. For users there is hardly any difference. +The default is splitting source and doc files out. Finally, the depend release/NNNN-YOUR_ID @@ -164,6 +175,12 @@ 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). +For local packages or those that are not in the TeX catalogue it is +nice to provide descriptions in the two fields + shortdesc + longdesc +again, see the TLPSRC.pm documentation. + If you want to use the auto-generated patterns we are using in TeX Live you have to copy our 00texlive.autopatterns.tlpsrc into your tlpkg/tlpsrc directory. @@ -189,9 +206,9 @@ POD documentation in TLPSRC.pm. 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 PATH-TO/tl-update-tlpdb OPTIONS -Here PATH-TO points to the directory Master/tlpkg/bin in your TeX Live -checkout, or where you have saved the files from TeXLive and tlpkg -directories. +from within ROOT. Here PATH-TO points to the directory Master/tlpkg/bin +in your TeX Live checkout, or where you have saved the files from +TeXLive and tlpkg directories. How revision numbers are computed and which files are used can be controlled by one of the several -from-XXXX options. By default Subversion is used. @@ -276,7 +293,7 @@ it should be created. In the former case only those containers with larger revision numbers are recreated. In the latter case all containers are created. --master `pwd` +-master ROOT The option -master defines the location of *your* files, that is ROOT in this document. @@ -378,4 +395,4 @@ If you have further comments, questions, additions to this file please let us know at tex-live@tug.org. -Last changed 2018-02-13 by np +Last changed 2018-03-08 by np |