From e5a3c2aef0a4222f70682361f07ef47ec7e9d0ad Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 20 Feb 2018 23:58:02 +0000 Subject: ci wording tweaks git-svn-id: svn://tug.org/texlive/trunk@46691 c570f23f-e606-0410-a88d-b1316a301751 --- Build/source/doc/ChangeLog | 2 +- Build/source/doc/tlbuild.info | 547 +++++++++++++++++++++--------------------- Build/source/doc/tlbuild.texi | 84 ++++--- 3 files changed, 318 insertions(+), 315 deletions(-) (limited to 'Build') diff --git a/Build/source/doc/ChangeLog b/Build/source/doc/ChangeLog index fff890b60d6..e02191522e6 100644 --- a/Build/source/doc/ChangeLog +++ b/Build/source/doc/ChangeLog @@ -1,6 +1,6 @@ 2018-02-20 Karl Berry - * tlbuild.texi (Continuous integration): Texinfo syntax. + * tlbuild.texi (Continuous integration): Texinfo syntax, wording. 2018-02-20 Norbert Preining diff --git a/Build/source/doc/tlbuild.info b/Build/source/doc/tlbuild.info index 1e2ca4fd3da..0ee1af80383 100644 --- a/Build/source/doc/tlbuild.info +++ b/Build/source/doc/tlbuild.info @@ -2037,39 +2037,37 @@ File: tlbuild.info, Node: Continuous integration, Next: install-tl, Prev: Cod 10 Continuous integration ************************* -The sources of TeX Live are subjected to continuous integration testing -on Travis-CI () via a -git-svn mirror of the sources that is pushed to Github +Overview: the sources of TeX Live are subjected to continuous +integration testing on Travis-CI +() via a git-svn mirror +of the sources that is pushed to Github (). The git-svn mirror is -updated (currently) at a 30min interval and only the last commit pushed -is tested on Travis-CI. +updated (currently) at 30 minute intervals, and only the last commit +pushed is tested on Travis-CI. Transfer from Subversion to Github ---------------------------------- -Git-svn () is used to check out the +git-svn () is used to check out the subtree 'Build/source' of the Subversion repository. The author index -file used is not maintained in Git or Subversion but provided on demand. +file used is not maintained in either Git or Subversion but can be +provided on request. - TODO what should we do here with the author index file? It contains -a mapping from subversion names to name/email as shown in git. + The initial checkout was done by invoking + git svn --authors-file usermap clone svn://USER@tug.org/texlive/trunk/Build/source - The initial checkout was done by invoking 'git svn --authors-file -usermap clone svn://USER@tug.org/texlive/trunk/Build/source' where the -'usermap' file maps subversion user names to name and emails of the -authors. +where the 'usermap' file maps Subversion user names to name and emails +of the authors. - TODO should we use anonymous checkout here? Should be possible! - - In the following we will refer with _admin_ to a user who has -read/write access to the TeX Live subversion repository, and an + In the following, we will use _admin_ to refer to a user who has +read/write access to the TeX Live subversion repository, and is also an administrator of the 'TeX-Live' Team on Github. The above initial checkout has been carried out by _admin_ on the server 'texlive.info'. - On Github () a new git repository named + On Github (), a new git repository named 'texlive-source' was created by _admin_ within the 'TeX-Live' -organization (), the remote added to the -checkout with 'git remote add origin +"organization" (). The remote was added to +the checkout with 'git remote add origin git@github.com:TeX-Live/texlive-source.git'. To automate the update on Github, a new ssh key was generated and @@ -2082,33 +2080,32 @@ history in the master branch. Since we are aiming at a pure mirror facility, we have decided to further restrict the 'master' branch of the 'texlive-source' repository on Github to changes by _admin_. - This setup allows other developers to branch of 'master' and push -their branches to the Github repository, but all updates need to from -the local 'master' (not the one on Github) to Subversion and back to -'master' on 'texlive.info' and from there to Github. See below for -setup for developers. + This setup allows other developers to branch off 'master' and push +their branches to the Github repository, but all updates need to come +from the local 'master' (not the one on Github) to Subversion, back to +'master' on 'texlive.info', and from there to Github. Automatic update of the Git mirror ---------------------------------- -_admin_ has installed a cron job on 'texlive.info' running every 30min -which basically runs 'git svn rebase' and 'git push' in the 'master' -branch of the checkout. The first command fetches the changes from the -Subversion repository and updates the 'master' branch with them, the -second one pushes changes (if available) to Github. +_admin_ has installed a cron job on 'texlive.info' running every 30 +minute which essentially runs 'git svn rebase' and 'git push' in the +'master' branch of the checkout. The first command fetches the changes +from the Subversion repository and updates the 'master' branch with +them, the second one pushes changes (if available) to Github. CI testing on Travis-CI ----------------------- -The 'source' tree of TeX Live contains a file '.travis.yml' which -controls the automatic testing on Travis-CI. _admin_ has registered to -Travis-CI and allowed access to the Github's 'TeX-Live' organization's -'texlive-source' repository. The default settings are to build the last -commit of each push. No further action is necessary on Travis-CI. +The 'source' tree of TeX Live contains a top-level file '.travis.yml' +which controls the automatic testing on Travis-CI. _admin_ has +registered to Travis-CI and allowed access to the Github's 'TeX-Live' +organization's 'texlive-source' repository. The default settings are to +build the last commit of each push. No further action is necessary on +Travis-CI. - In case changes have been pushed during the cron job mentioned above, -Travis-CI will automatically checkout the last pushed commit and try -building it. + If changes have been pushed via the cron job above, Travis-CI will +automatically checkout the last pushed commit and try building it.  File: tlbuild.info, Node: install-tl, Next: tlmgr, Prev: Continuous integration, Up: Top @@ -4640,6 +4637,8 @@ Index * --without-x: --without-x. (line 6) * -C configure option: Build in parallel. (line 11) * -j make option: Build in parallel. (line 6) +* .travis.yml: Continuous integration. + (line 66) * adapting TeX Live for distros: Distro builds. (line 54) * adding a new generic library: Adding a new generic library module. (line 6) @@ -5142,241 +5141,241 @@ Node: Coding conventions76348 Node: Declarations and definitions77087 Node: Const79269 Node: Continuous integration81132 -Node: install-tl84689 -Node: install-tl NAME85034 -Node: install-tl SYNOPSIS85192 -Node: install-tl DESCRIPTION85400 -Node: install-tl REFERENCES86401 -Node: install-tl OPTIONS86917 -Ref: install-tl *-gui* [[=]_module_]87271 -Ref: install-tl text87480 -Ref: install-tl wizard87603 -Ref: install-tl perltk87757 -Ref: install-tl *-no-gui*88191 -Ref: install-tl *-lang* _llcode_88272 -Ref: install-tl *-repository* _url|path_88959 -Ref: install-tl *-select-repository*90770 -Ref: install-tl *-all-options*91206 -Ref: install-tl *-custom-bin* _path_91513 -Ref: install-tl *-debug-translation*92168 -Ref: install-tl *-force-platform* _platform_92387 -Ref: install-tl *-help*, *--help*, *-?*92631 -Ref: install-tl *-in-place*93024 -Ref: install-tl *-logfile* _file_93551 -Ref: install-tl *-no-cls*93902 -Ref: install-tl *-non-admin*94033 -Ref: install-tl *--persistent-downloads*94138 -Ref: install-tl *--no-persistent-downloads*94166 -Ref: install-tl *-portable*94774 -Ref: install-tl *-print-platform*94913 -Ref: install-tl *-profile* _profile_95106 -Ref: install-tl *-q*96600 -Ref: install-tl *-scheme* _scheme_96662 -Ref: install-tl *-v*97136 -Ref: install-tl *-version*, *--version*97297 -Node: install-tl ENVIRONMENT VARIABLES97428 -Ref: install-tl TEXLIVE_INSTALL_ENV_NOCHECK97817 -Ref: install-tl TEXLIVE_INSTALL_NO_CONTEXT_CACHE98019 -Ref: install-tl TEXLIVE_INSTALL_PREFIX98125 -Ref: install-tl TEXLIVE_INSTALL_TEXMFCONFIG98156 -Ref: install-tl TEXLIVE_INSTALL_TEXMFHOME98185 -Ref: install-tl TEXLIVE_INSTALL_TEXMFLOCAL98215 -Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSCONFIG98249 -Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSVAR98280 -Ref: install-tl TEXLIVE_INSTALL_TEXMFVAR98308 -Ref: install-tl NOPERLDOC98363 -Node: install-tl AUTHORS AND COPYRIGHT98427 -Node: tlmgr98785 -Node: tlmgr NAME99222 -Node: tlmgr SYNOPSIS99347 -Node: tlmgr DESCRIPTION99537 -Node: tlmgr EXAMPLES100633 -Ref: tlmgr tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet100924 -Ref: tlmgr tlmgr update --list101105 -Ref: tlmgr tlmgr update --all101198 -Ref: tlmgr tlmgr info _pkg_101354 -Node: tlmgr OPTIONS101560 -Ref: tlmgr *--repository* _url|path_102080 -Ref: tlmgr *--gui* [_action_]102805 -Ref: tlmgr *--gui-lang* _llcode_103212 -Ref: tlmgr *--debug-translation*103895 -Ref: tlmgr *--machine-readable*104098 -Ref: tlmgr *--no-execute-actions*104366 -Ref: tlmgr *--package-logfile* _file_104559 -Ref: tlmgr *--pause*104814 -Ref: tlmgr *--persistent-downloads*104969 -Ref: tlmgr *--no-persistent-downloads*104997 -Ref: tlmgr *--pin-file*105491 -Ref: tlmgr *--usermode*105709 -Ref: tlmgr *--usertree* _dir_105829 -Node: tlmgr ACTIONS106379 -Node: tlmgr help107611 -Node: tlmgr version108087 -Node: tlmgr backup [--clean[=_N_]] [--backupdir _dir_] [--all | _pkg_]...108405 -Ref: tlmgr *--backupdir* _directory_109499 -Ref: tlmgr *--all*109696 -Ref: tlmgr *--clean*[=_N_]109918 -Ref: tlmgr *--dry-run*110215 -Node: tlmgr candidates _pkg_110335 -Ref: tlmgr *candidates _pkg_* 1110622 -Node: tlmgr check [_option_]... [files|depends|executes|runfiles|all]110766 -Ref: tlmgr *files*111209 -Ref: tlmgr *depends*111344 -Ref: tlmgr *executes*111686 -Ref: tlmgr *runfiles*111804 -Ref: tlmgr *--use-svn*111916 -Node: tlmgr conf [texmf|tlmgr|updmap [--conffile _file_] [--delete] [_key_ [_value_]]]112033 -Node: tlmgr dump-tlpdb [--local|--remote]114105 -Ref: tlmgr *--local*114615 -Ref: tlmgr *--remote*114654 -Node: tlmgr generate [_option_]... _what_115076 -Ref: tlmgr *generate language*115317 -Ref: tlmgr *generate language.dat*115342 -Ref: tlmgr *generate language.def*115367 -Ref: tlmgr *generate language.dat.lua*115396 -Ref: tlmgr *generate fmtutil*115416 -Ref: tlmgr *--dest* _output_file_117653 -Ref: tlmgr *--localcfg* _local_conf_file_118229 -Ref: tlmgr *--rebuild-sys*118352 -Node: tlmgr gui119213 -Node: tlmgr info [_option_...] [collections|schemes|_pkg_...]119457 -Ref: tlmgr *--list*120662 -Ref: tlmgr *--only-installed*120941 -Ref: tlmgr *--taxonomy*121156 -Ref: tlmgr *--keyword*121168 -Ref: tlmgr *--functionality*121186 -Ref: tlmgr *--characterization*121207 -Node: tlmgr init-usertree121420 -Node: tlmgr install [_option_]... _pkg_...121846 -Ref: tlmgr *--file*122210 -Ref: tlmgr *--reinstall*122436 -Ref: tlmgr *--no-depends*122816 -Ref: tlmgr *--no-depends-at-all*122975 -Ref: tlmgr *--dry-run* 1123373 -Ref: tlmgr *--force*123491 -Node: tlmgr option123697 -Ref: tlmgr *option [show]*123870 -Ref: tlmgr *option showall*123888 -Ref: tlmgr *option _key_ [_value_]*123914 -Node: tlmgr paper127762 -Ref: tlmgr *paper [a4|letter]*127947 -Ref: tlmgr *[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [_papersize_|--list]*128021 -Node: tlmgr path [--w32mode=user|admin] [add|remove]129048 -Node: tlmgr pinning130531 -Ref: tlmgr pinning show130838 -Ref: tlmgr pinning add _repo_ _pkgglob_...130911 -Ref: tlmgr pinning remove _repo_ _pkgglob_...131030 -Ref: tlmgr pinning remove _repo_ --all131183 -Node: tlmgr platform list|add|remove _platform_...131237 -Node: tlmgr platform set _platform_131485 -Node: tlmgr platform set auto131713 -Ref: tlmgr *--dry-run* 2132830 -Node: tlmgr postaction [--w32mode=user|admin] [--fileassocmode=1|2] [--all] [install|remove] [shortcut|fileassoc|script] [_pkg_]...132939 -Node: tlmgr print-platform134241 -Node: tlmgr restore [--backupdir _dir_] [--all | _pkg_ [_rev_]]134713 -Ref: tlmgr *--all* 1135609 -Ref: tlmgr *--backupdir* _directory_ 1135803 -Ref: tlmgr *--dry-run* 3135959 -Ref: tlmgr *--force* 1136076 -Node: tlmgr remove [_option_]... _pkg_...136104 -Ref: tlmgr *--no-depends* 1136627 -Ref: tlmgr *--no-depends-at-all* 1136689 -Ref: tlmgr *--force* 2136745 -Ref: tlmgr *--dry-run* 4137217 -Node: tlmgr repository137324 -Ref: tlmgr *repository list*137532 -Ref: tlmgr *repository list _path|tag_*137562 -Ref: tlmgr *repository add _path_ [_tag_]*137595 -Ref: tlmgr *repository remove _path|tag_*137627 -Ref: tlmgr *repository set _path_[#_tag_] [_path_[#_tag_] ...]*137681 -Node: tlmgr search [_option_...] _what_138765 -Node: tlmgr search [_option_...] --file _what_139276 -Node: tlmgr search [_option_...] --taxonomy _what_139527 -Node: tlmgr search [_option_...] --keyword _what_139838 -Node: tlmgr search [_option_...] --functionality _what_140156 -Node: tlmgr search [_option_...] --characterization _what_140494 -Node: tlmgr search [_option_...] --all _what_140834 -Ref: tlmgr *--global*141282 -Ref: tlmgr *--word*141394 -Ref: tlmgr *--list* 1141633 -Ref: tlmgr *--file* 1141979 -Ref: tlmgr *--taxonomy* 1142036 -Ref: tlmgr *--keyword* 1142048 -Ref: tlmgr *--functionality* 1142066 -Ref: tlmgr *--characterization* 1142087 -Ref: tlmgr *--all* 2142242 -Node: tlmgr uninstall142325 -Ref: tlmgr *--force* 3142579 -Node: tlmgr update [_option_]... [_pkg_]...142635 -Ref: tlmgr *--all* 3143006 -Ref: tlmgr *--self*144747 -Ref: tlmgr *--dry-run* 5145511 -Ref: tlmgr *--list* [_pkg_]145688 -Ref: tlmgr *--exclude* _pkg_146377 -Ref: tlmgr *--no-auto-remove* [_pkg_]...147070 -Ref: tlmgr *--no-auto-install* [_pkg_]...147521 -Ref: tlmgr *--reinstall-forcibly-removed*148177 -Ref: tlmgr *--backup* and *--backupdir* _directory_148741 -Ref: tlmgr *--no-depends* 2149922 -Ref: tlmgr *--no-depends-at-all* 2150125 -Ref: tlmgr *--force* 4150181 -Node: tlmgr USER MODE150607 -Node: tlmgr user mode install153418 -Node: tlmgr user mode backup; restore; remove; update154365 -Node: tlmgr user mode generate; option; paper154807 -Node: tlmgr CONFIGURATION FILE FOR TLMGR155183 -Node: tlmgr TAXONOMIES156274 -Ref: tlmgr --keyword 2156900 -Ref: tlmgr --functionality 2156985 -Ref: tlmgr --characterization 2157141 -Ref: tlmgr --taxonomy 2157282 -Node: tlmgr MULTIPLE REPOSITORIES157823 -Node: tlmgr Pinning159544 -Node: tlmgr GUI FOR TLMGR161519 -Node: tlmgr Main display162741 -Node: tlmgr Display configuration area162993 -Ref: tlmgr Status163354 -Ref: tlmgr Category163518 -Ref: tlmgr Match163704 -Ref: tlmgr Selection163964 -Ref: tlmgr Display configuration buttons164168 -Node: tlmgr Package list area164351 -Ref: tlmgr a checkbox164935 -Ref: tlmgr package name165071 -Ref: tlmgr local revision (and version)165170 -Ref: tlmgr remote revision (and version)165545 -Ref: tlmgr short description165842 -Node: tlmgr Main display action buttons165887 -Ref: tlmgr Update all installed166153 -Ref: tlmgr Update166525 -Ref: tlmgr Install166575 -Ref: tlmgr Remove166761 -Ref: tlmgr Backup166939 -Node: tlmgr Menu bar167096 -Ref: tlmgr tlmgr menu167293 -Ref: tlmgr Options menu167601 -Ref: tlmgr Actions menu168684 -Ref: tlmgr Help menu169112 -Node: tlmgr MACHINE-READABLE OUTPUT169245 -Node: tlmgr Machine-readable update and install output170055 -Ref: tlmgr location-url _location_171331 -Ref: tlmgr total-bytes _count_171547 -Ref: tlmgr _pkgname_171957 -Ref: tlmgr _status_172167 -Ref: tlmgr d172245 -Ref: tlmgr f172305 -Ref: tlmgr u172484 -Ref: tlmgr r172530 -Ref: tlmgr a172653 -Ref: tlmgr i172831 -Ref: tlmgr I172950 -Ref: tlmgr _localrev_173052 -Ref: tlmgr _serverrev_173159 -Ref: tlmgr _size_173271 -Ref: tlmgr _runtime_173440 -Ref: tlmgr _esttot_173510 -Node: tlmgr Machine-readable option output173543 -Node: tlmgr AUTHORS AND COPYRIGHT174055 -Node: Index174402 +Node: install-tl84499 +Node: install-tl NAME84844 +Node: install-tl SYNOPSIS85002 +Node: install-tl DESCRIPTION85210 +Node: install-tl REFERENCES86211 +Node: install-tl OPTIONS86727 +Ref: install-tl *-gui* [[=]_module_]87081 +Ref: install-tl text87290 +Ref: install-tl wizard87413 +Ref: install-tl perltk87567 +Ref: install-tl *-no-gui*88001 +Ref: install-tl *-lang* _llcode_88082 +Ref: install-tl *-repository* _url|path_88769 +Ref: install-tl *-select-repository*90580 +Ref: install-tl *-all-options*91016 +Ref: install-tl *-custom-bin* _path_91323 +Ref: install-tl *-debug-translation*91978 +Ref: install-tl *-force-platform* _platform_92197 +Ref: install-tl *-help*, *--help*, *-?*92441 +Ref: install-tl *-in-place*92834 +Ref: install-tl *-logfile* _file_93361 +Ref: install-tl *-no-cls*93712 +Ref: install-tl *-non-admin*93843 +Ref: install-tl *--persistent-downloads*93948 +Ref: install-tl *--no-persistent-downloads*93976 +Ref: install-tl *-portable*94584 +Ref: install-tl *-print-platform*94723 +Ref: install-tl *-profile* _profile_94916 +Ref: install-tl *-q*96410 +Ref: install-tl *-scheme* _scheme_96472 +Ref: install-tl *-v*96946 +Ref: install-tl *-version*, *--version*97107 +Node: install-tl ENVIRONMENT VARIABLES97238 +Ref: install-tl TEXLIVE_INSTALL_ENV_NOCHECK97627 +Ref: install-tl TEXLIVE_INSTALL_NO_CONTEXT_CACHE97829 +Ref: install-tl TEXLIVE_INSTALL_PREFIX97935 +Ref: install-tl TEXLIVE_INSTALL_TEXMFCONFIG97966 +Ref: install-tl TEXLIVE_INSTALL_TEXMFHOME97995 +Ref: install-tl TEXLIVE_INSTALL_TEXMFLOCAL98025 +Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSCONFIG98059 +Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSVAR98090 +Ref: install-tl TEXLIVE_INSTALL_TEXMFVAR98118 +Ref: install-tl NOPERLDOC98173 +Node: install-tl AUTHORS AND COPYRIGHT98237 +Node: tlmgr98595 +Node: tlmgr NAME99032 +Node: tlmgr SYNOPSIS99157 +Node: tlmgr DESCRIPTION99347 +Node: tlmgr EXAMPLES100443 +Ref: tlmgr tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet100734 +Ref: tlmgr tlmgr update --list100915 +Ref: tlmgr tlmgr update --all101008 +Ref: tlmgr tlmgr info _pkg_101164 +Node: tlmgr OPTIONS101370 +Ref: tlmgr *--repository* _url|path_101890 +Ref: tlmgr *--gui* [_action_]102615 +Ref: tlmgr *--gui-lang* _llcode_103022 +Ref: tlmgr *--debug-translation*103705 +Ref: tlmgr *--machine-readable*103908 +Ref: tlmgr *--no-execute-actions*104176 +Ref: tlmgr *--package-logfile* _file_104369 +Ref: tlmgr *--pause*104624 +Ref: tlmgr *--persistent-downloads*104779 +Ref: tlmgr *--no-persistent-downloads*104807 +Ref: tlmgr *--pin-file*105301 +Ref: tlmgr *--usermode*105519 +Ref: tlmgr *--usertree* _dir_105639 +Node: tlmgr ACTIONS106189 +Node: tlmgr help107421 +Node: tlmgr version107897 +Node: tlmgr backup [--clean[=_N_]] [--backupdir _dir_] [--all | _pkg_]...108215 +Ref: tlmgr *--backupdir* _directory_109309 +Ref: tlmgr *--all*109506 +Ref: tlmgr *--clean*[=_N_]109728 +Ref: tlmgr *--dry-run*110025 +Node: tlmgr candidates _pkg_110145 +Ref: tlmgr *candidates _pkg_* 1110432 +Node: tlmgr check [_option_]... [files|depends|executes|runfiles|all]110576 +Ref: tlmgr *files*111019 +Ref: tlmgr *depends*111154 +Ref: tlmgr *executes*111496 +Ref: tlmgr *runfiles*111614 +Ref: tlmgr *--use-svn*111726 +Node: tlmgr conf [texmf|tlmgr|updmap [--conffile _file_] [--delete] [_key_ [_value_]]]111843 +Node: tlmgr dump-tlpdb [--local|--remote]113915 +Ref: tlmgr *--local*114425 +Ref: tlmgr *--remote*114464 +Node: tlmgr generate [_option_]... _what_114886 +Ref: tlmgr *generate language*115127 +Ref: tlmgr *generate language.dat*115152 +Ref: tlmgr *generate language.def*115177 +Ref: tlmgr *generate language.dat.lua*115206 +Ref: tlmgr *generate fmtutil*115226 +Ref: tlmgr *--dest* _output_file_117463 +Ref: tlmgr *--localcfg* _local_conf_file_118039 +Ref: tlmgr *--rebuild-sys*118162 +Node: tlmgr gui119023 +Node: tlmgr info [_option_...] [collections|schemes|_pkg_...]119267 +Ref: tlmgr *--list*120472 +Ref: tlmgr *--only-installed*120751 +Ref: tlmgr *--taxonomy*120966 +Ref: tlmgr *--keyword*120978 +Ref: tlmgr *--functionality*120996 +Ref: tlmgr *--characterization*121017 +Node: tlmgr init-usertree121230 +Node: tlmgr install [_option_]... _pkg_...121656 +Ref: tlmgr *--file*122020 +Ref: tlmgr *--reinstall*122246 +Ref: tlmgr *--no-depends*122626 +Ref: tlmgr *--no-depends-at-all*122785 +Ref: tlmgr *--dry-run* 1123183 +Ref: tlmgr *--force*123301 +Node: tlmgr option123507 +Ref: tlmgr *option [show]*123680 +Ref: tlmgr *option showall*123698 +Ref: tlmgr *option _key_ [_value_]*123724 +Node: tlmgr paper127572 +Ref: tlmgr *paper [a4|letter]*127757 +Ref: tlmgr *[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [_papersize_|--list]*127831 +Node: tlmgr path [--w32mode=user|admin] [add|remove]128858 +Node: tlmgr pinning130341 +Ref: tlmgr pinning show130648 +Ref: tlmgr pinning add _repo_ _pkgglob_...130721 +Ref: tlmgr pinning remove _repo_ _pkgglob_...130840 +Ref: tlmgr pinning remove _repo_ --all130993 +Node: tlmgr platform list|add|remove _platform_...131047 +Node: tlmgr platform set _platform_131295 +Node: tlmgr platform set auto131523 +Ref: tlmgr *--dry-run* 2132640 +Node: tlmgr postaction [--w32mode=user|admin] [--fileassocmode=1|2] [--all] [install|remove] [shortcut|fileassoc|script] [_pkg_]...132749 +Node: tlmgr print-platform134051 +Node: tlmgr restore [--backupdir _dir_] [--all | _pkg_ [_rev_]]134523 +Ref: tlmgr *--all* 1135419 +Ref: tlmgr *--backupdir* _directory_ 1135613 +Ref: tlmgr *--dry-run* 3135769 +Ref: tlmgr *--force* 1135886 +Node: tlmgr remove [_option_]... _pkg_...135914 +Ref: tlmgr *--no-depends* 1136437 +Ref: tlmgr *--no-depends-at-all* 1136499 +Ref: tlmgr *--force* 2136555 +Ref: tlmgr *--dry-run* 4137027 +Node: tlmgr repository137134 +Ref: tlmgr *repository list*137342 +Ref: tlmgr *repository list _path|tag_*137372 +Ref: tlmgr *repository add _path_ [_tag_]*137405 +Ref: tlmgr *repository remove _path|tag_*137437 +Ref: tlmgr *repository set _path_[#_tag_] [_path_[#_tag_] ...]*137491 +Node: tlmgr search [_option_...] _what_138575 +Node: tlmgr search [_option_...] --file _what_139086 +Node: tlmgr search [_option_...] --taxonomy _what_139337 +Node: tlmgr search [_option_...] --keyword _what_139648 +Node: tlmgr search [_option_...] --functionality _what_139966 +Node: tlmgr search [_option_...] --characterization _what_140304 +Node: tlmgr search [_option_...] --all _what_140644 +Ref: tlmgr *--global*141092 +Ref: tlmgr *--word*141204 +Ref: tlmgr *--list* 1141443 +Ref: tlmgr *--file* 1141789 +Ref: tlmgr *--taxonomy* 1141846 +Ref: tlmgr *--keyword* 1141858 +Ref: tlmgr *--functionality* 1141876 +Ref: tlmgr *--characterization* 1141897 +Ref: tlmgr *--all* 2142052 +Node: tlmgr uninstall142135 +Ref: tlmgr *--force* 3142389 +Node: tlmgr update [_option_]... [_pkg_]...142445 +Ref: tlmgr *--all* 3142816 +Ref: tlmgr *--self*144557 +Ref: tlmgr *--dry-run* 5145321 +Ref: tlmgr *--list* [_pkg_]145498 +Ref: tlmgr *--exclude* _pkg_146187 +Ref: tlmgr *--no-auto-remove* [_pkg_]...146880 +Ref: tlmgr *--no-auto-install* [_pkg_]...147331 +Ref: tlmgr *--reinstall-forcibly-removed*147987 +Ref: tlmgr *--backup* and *--backupdir* _directory_148551 +Ref: tlmgr *--no-depends* 2149732 +Ref: tlmgr *--no-depends-at-all* 2149935 +Ref: tlmgr *--force* 4149991 +Node: tlmgr USER MODE150417 +Node: tlmgr user mode install153228 +Node: tlmgr user mode backup; restore; remove; update154175 +Node: tlmgr user mode generate; option; paper154617 +Node: tlmgr CONFIGURATION FILE FOR TLMGR154993 +Node: tlmgr TAXONOMIES156084 +Ref: tlmgr --keyword 2156710 +Ref: tlmgr --functionality 2156795 +Ref: tlmgr --characterization 2156951 +Ref: tlmgr --taxonomy 2157092 +Node: tlmgr MULTIPLE REPOSITORIES157633 +Node: tlmgr Pinning159354 +Node: tlmgr GUI FOR TLMGR161329 +Node: tlmgr Main display162551 +Node: tlmgr Display configuration area162803 +Ref: tlmgr Status163164 +Ref: tlmgr Category163328 +Ref: tlmgr Match163514 +Ref: tlmgr Selection163774 +Ref: tlmgr Display configuration buttons163978 +Node: tlmgr Package list area164161 +Ref: tlmgr a checkbox164745 +Ref: tlmgr package name164881 +Ref: tlmgr local revision (and version)164980 +Ref: tlmgr remote revision (and version)165355 +Ref: tlmgr short description165652 +Node: tlmgr Main display action buttons165697 +Ref: tlmgr Update all installed165963 +Ref: tlmgr Update166335 +Ref: tlmgr Install166385 +Ref: tlmgr Remove166571 +Ref: tlmgr Backup166749 +Node: tlmgr Menu bar166906 +Ref: tlmgr tlmgr menu167103 +Ref: tlmgr Options menu167411 +Ref: tlmgr Actions menu168494 +Ref: tlmgr Help menu168922 +Node: tlmgr MACHINE-READABLE OUTPUT169055 +Node: tlmgr Machine-readable update and install output169865 +Ref: tlmgr location-url _location_171141 +Ref: tlmgr total-bytes _count_171357 +Ref: tlmgr _pkgname_171767 +Ref: tlmgr _status_171977 +Ref: tlmgr d172055 +Ref: tlmgr f172115 +Ref: tlmgr u172294 +Ref: tlmgr r172340 +Ref: tlmgr a172463 +Ref: tlmgr i172641 +Ref: tlmgr I172760 +Ref: tlmgr _localrev_172862 +Ref: tlmgr _serverrev_172969 +Ref: tlmgr _size_173081 +Ref: tlmgr _runtime_173250 +Ref: tlmgr _esttot_173320 +Node: tlmgr Machine-readable option output173353 +Node: tlmgr AUTHORS AND COPYRIGHT173865 +Node: Index174212  End Tag Table diff --git a/Build/source/doc/tlbuild.texi b/Build/source/doc/tlbuild.texi index 08b1e1e87d4..5464bbc07d7 100644 --- a/Build/source/doc/tlbuild.texi +++ b/Build/source/doc/tlbuild.texi @@ -2490,41 +2490,45 @@ cause the modification of quantities supposed to be constant. @cindex continuous integration @cindex Travis-CI -The sources of @TL{} are subjected to continuous integration testing on -Travis-CI (@url{https://travis-ci.org/TeX-Live/texlive-source}) via a -git-svn mirror of the sources that is pushed to Github +Overview: the sources of @TL{} are subjected to continuous integration +testing on Travis-CI +(@url{https://travis-ci.org/TeX-Live/texlive-source}) via a git-svn +mirror of the sources that is pushed to Github (@url{https://github.com/TeX-Live/texlive-source}). The git-svn mirror -is updated (currently) at a 30min interval and only the last commit -pushed is tested on Travis-CI. +is updated (currently) at 30 minute intervals, and only the last +commit pushed is tested on Travis-CI. @subheading Transfer from Subversion to Github -Git-svn (@url{https://git-scm.com/docs/git-svn}) is used to check out -the subtree @code{Build/source} of the Subversion repository. The author -index file used is not maintained in Git or Subversion but provided on -demand. +git-svn (@url{https://git-scm.com/docs/git-svn}) is used to check out +the subtree @code{Build/source} of the Subversion repository. The +author index file used is not maintained in either Git or Subversion +but can be provided on request. -TODO what should we do here with the author index file? It contains a -mapping from subversion names to name/email as shown in git. +@c TODO what should we do here with the author index file? It contains a +@c mapping from subversion names to name/email as shown in git. The initial checkout was done by invoking -@code{git svn --authors-file usermap clone svn://USER@@tug.org/texlive/trunk/Build/source} -where the @code{usermap} file maps subversion user names to name and -emails of the authors. +@example +git svn --authors-file usermap clone svn://USER@@tug.org/texlive/trunk/Build/source +@end example + +@noindent where the @code{usermap} file maps Subversion user names to +name and emails of the authors. -TODO should we use anonymous checkout here? Should be possible! +@c TODO should we use anonymous checkout here? Should be possible! -In the following we will refer with @emph{admin} to a user who has -read/write access to the @TL{} subversion repository, and an +In the following, we will use @emph{admin} to refer to a user who has +read/write access to the @TL{} subversion repository, and is also an administrator of the @code{TeX-Live} Team on Github. The above initial checkout has been carried out by @emph{admin} on the server -@code{texlive.info}. +@code{texlive.info}. -On Github (@url{https://github.com/}) a new git repository named +On Github (@url{https://github.com}), a new git repository named @code{texlive-source} was created by @emph{admin} within the -@code{TeX-Live} organization (@url{https://github.com/TeX-Live/}), the -remote added to the checkout with -@code{git remote add origin git@@github.com:TeX-Live/texlive-source.git}. +@code{TeX-Live} ``organization'' (@url{https://github.com/TeX-Live}). +The remote was added to the checkout with @code{git remote add origin +git@@github.com:TeX-Live/texlive-source.git}. To automate the update on Github, a new ssh key was generated and added to the @code{texlive-source} repository on Github as deployment @@ -2537,33 +2541,33 @@ mirror facility, we have decided to further restrict the @code{master} branch of the @code{texlive-source} repository on Github to changes by @emph{admin}. -This setup allows other developers to branch of @code{master} and +This setup allows other developers to branch off @code{master} and push their branches to the Github repository, but all updates need to -from the local @code{master} (not the one on Github) to Subversion and -back to @code{master} on @code{texlive.info} and from there to Github. -See below for setup for developers. +come from the local @code{master} (not the one on Github) to +Subversion, back to @code{master} on @code{texlive.info}, and from +there to Github. @subheading Automatic update of the Git mirror @emph{admin} has installed a cron job on @code{texlive.info} running -every 30min which basically runs @code{git svn rebase} and @code{git -push} in the @code{master} branch of the checkout. The first command -fetches the changes from the Subversion repository and updates the -@code{master} branch with them, the second one pushes changes (if -available) to Github. +every 30 minute which essentially runs @code{git svn rebase} and +@code{git push} in the @code{master} branch of the checkout. The first +command fetches the changes from the Subversion repository and updates +the @code{master} branch with them, the second one pushes changes (if +available) to Github. @subheading CI testing on Travis-CI -The @code{source} tree of @TL{} contains a file @code{.travis.yml} -which controls the automatic testing on Travis-CI. @emph{admin} has -registered to Travis-CI and allowed access to the Github's -@code{TeX-Live} organization's @code{texlive-source} repository. The -default settings are to build the last commit of each push. No further -action is necessary on Travis-CI. +@pindex .travis.yml +The @code{source} tree of @TL{} contains a top-level file +@code{.travis.yml} which controls the automatic testing on +Travis-CI. @emph{admin} has registered to Travis-CI and allowed access +to the Github's @code{TeX-Live} organization's @code{texlive-source} +repository. The default settings are to build the last commit of each +push. No further action is necessary on Travis-CI. -In case changes have been pushed during the cron job mentioned above, -Travis-CI will automatically checkout the last pushed commit and try -building it. +If changes have been pushed via the cron job above, Travis-CI will +automatically checkout the last pushed commit and try building it. @comment @comment The following needs improvement -- cgit v1.2.3