diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/building-with-db2latex_stalled.txt (renamed from doc/building-ng.txt) | 0 | ||||
| -rw-r--r-- | doc/translations.txt | 63 | ||||
| -rw-r--r-- | doc/translations_po.txt | 37 |
3 files changed, 51 insertions, 49 deletions
diff --git a/doc/building-ng.txt b/doc/building-with-db2latex_stalled.txt index 0c9d5027a..0c9d5027a 100644 --- a/doc/building-ng.txt +++ b/doc/building-with-db2latex_stalled.txt diff --git a/doc/translations.txt b/doc/translations.txt index f5910c290..83b55ac12 100644 --- a/doc/translations.txt +++ b/doc/translations.txt @@ -1,10 +1,12 @@ -Debian Installation Manual - notes for translation +Debian Installation Guide - notes for translation -------------------------------------------------- !!! Please note, that this file mostly documents xml-based !!! translations. But you can also translate this manual via po !!! files, if you want. This is documented in the file !!! translations_po.txt in this directory. +!!! And: using the po format is strongly recommended, using the +!!! xml format is deprecated! Note: if you happen to modify this file, please don't forget to update the trailing changelog @@ -12,10 +14,10 @@ Note: if you happen to modify this file, please don't forget to Where is the manual kept? ========================= -The manual is kept in a Subversion repository on svn.debian.org +The manual is kept in a git repository on salsa.debian.org as part of the Debian Installer (d-i) project. -The manual and its translations can be found in ./manual. +The manual and its translations can be found in ./installation-guide. How to join the translation effort for an existing translation ============================================================== @@ -31,7 +33,7 @@ translate and how to submit your translations. How to start a new translation ============================== -Starting a translation for a new language without write access to the d-i SVN +Starting a translation for a new language without write access to the d-i git repository really is not practical. See the section on getting SVN access below; you will also have to get a local working copy of the manual as described there. @@ -41,24 +43,24 @@ you will also have to get a local working copy of the manual as described there. base for your translation. This also ensures that your translation will be complete and can be built. A text that has not been translated yet, will be included in English. - - change directory to: ./manual/ + - change directory to: ./installation-guide/ - cp -R en/ <lang> (where <lang> is the ISO code for your language: xx or xx_XX) - - find <lang> -name .svn | xargs rm -Rf - (this removes all .svn subdirectories) + - find <lang> -name .git | xargs rm -Rf + (this removes all .git subdirectories) 2. Convert revision comments ---------------------------- This enables you to track changes in the original English documents. see 'Keeping your translation up to date' below for an explanation. - - change directory to: ./manual/ + - change directory to: ./installation-guide/ - ./scripts/rev-update <lang> - 3. Commit the changes to SVN + 3. Commit the changes to git ---------------------------- - - change directory to: ./manual/ - - svn add <lang> - - svn ci -m "Manual: creating new translation for <lang>" + - change directory to: ./installation-guide/ + - git add <lang>/* + - git commit -m "installation-guide: creating new translation for <lang>" One more change is needed to get your translation building automatically: <lang> needs to be added to the 'languages' variable in build/build.sh. @@ -216,46 +218,38 @@ You can also try to build the manual (create HTML pages) for a specific architecture for your language. See ./build/README for more information on building the manual. -How to get write access to the SVN repository +How to get write access to the git repository ============================================= - 1) Installing subversion + 1) Installing git ------------------------ You need to install subversion on your system. Just do - apt-get install subversion + apt install git - 2) Getting write access to the subversion repository + 2) Getting write access to the git repository ---------------------------------------------------- If you are not a Debian Developer, you first need to create a guest account - on http://alioth.debian.org/, than ask on debian-boot@lists.debian.org + on https://salsa.debian.org/, than ask on debian-boot@lists.debian.org for somebody to add your guest account to the debian-installer project. - 3) Using subversion to get files + 3) Using git to get files -------------------------------- Once your account is allowed to write to the project, you can retrieve the - full project using this: - svn co svn+ssh://<username>@svn.debian.org/svn/d-i/trunk - If you only want to work on the manual, you can retrieve the relevant part - of the repository using: - svn co svn+ssh://<username>@svn.debian.org/svn/d-i/trunk/manual + installation-guide using this: + git clone git@salsa.debian.org:installer-team/installation-guide.git - 4) Commit your changed translation files to SVN + 4) Commit your changed translation files to git ----------------------------------------------- After you have finished editing your translation, use - svn commit -m "Your comment about this commit" - to commit your changes to the SVN repository. + git add path-to-file(s) + git commit -m "Your comment about this commit" + git push + to commit your changes to the git repository. - Note: it's possible to do an anonymous checkout from the svn - (use svn co svn://svn.debian.org/d-i/trunk/manual). - However, from this local copy you aren't able to commit, it's readonly. - Use the commands listed under 3) if you plan to do commits in the future. - - -You can find a good manual for SVN at http://svnbook.red-bean.com/. How to get help =============== @@ -307,3 +301,6 @@ Changelog: 2017/04/12 Holger Wansing - Add hint on translations_po.txt + +2018/06/03 Holger Wansing + - Updating (most) content on git migration diff --git a/doc/translations_po.txt b/doc/translations_po.txt index 8961ae8b7..1657de81b 100644 --- a/doc/translations_po.txt +++ b/doc/translations_po.txt @@ -1,8 +1,8 @@ -Debian Installation Manual - notes for translation +Debian Installation Guide - notes for translations -------------------------------------------------- This file explains how to translate the manual using .po files. -This is now officially supported. +This is now officially supported and the recommended way. !!! For general information on translating the manual, please see the !!! translations.txt file. @@ -50,7 +50,7 @@ poxml tools. using .po files - ./scripts/set_untranslated : used for the conversion of existing translations -All scripts should be run from the ./manual directory and take the language as +All scripts should be run from the ./installation-guide directory and take the language as parameter. @@ -62,8 +62,8 @@ to switch from translating XML files to using PO files. The template files for the manual are available in ./po/pot, so all you need to do is create a new directory for your language (using the official ISO -code for your language) and copy the .pot file you want to translate to a -.po file in that directory. +code for your language) and copy all the .pot files to a .po file in that +directory. Example for a Dutch translation: - mkdir ./po/nl @@ -77,22 +77,22 @@ start translating them. Committing your translation =========================== -The translation can be committed to d-i's SVN repository using: - 1. svn ci ./po/<your language> -m "<some comment describing the changes>" +The translation can be committed to d-i's git repository using: + 1. git add ./po/<lang>/* + 2. git commit -m "<some comment describing the changes>" + 2. git push -If this is the first time you commit the translation of a file, you will need -to run the 'svn add' command on the new files before you do 'svn ci'. -Tip: use the commands 'svn st ' and 'svn diff' before you commit your changes -to check what you are committing before you run the 'svn ci' command. +Tip: use the command 'git diff -u' before you commit your changes (step 2), +to check what you are committing. Updating your translation ========================= The PO files for your language and the templates for the manual are updated regularly when there are changes in the original English XML -files. This is done during the "daily" builds (currently done by -Frans Pop); you should not have to update your PO files yourself, but -rather get the updates using 'svn up'. Changed strings will be marked +files. This is done during the "daily" builds (currently done by the i18n +coordinator); you should not have to update your PO files yourself, but +rather get the updates using 'git pull'. Changed strings will be marked 'fuzzy' and new strings will be untranslated. After this your PO files in the ./po directory should be updated and you can @@ -100,13 +100,13 @@ update the translation with your favorite PO file editor. To commit the changes, follow again the procedure described in the previous section. To update the POT and PO files manually, use the following commands: - 1. svn up + 1. git pull 2. ./scripts/merge_xml en 3. ./scripts/update_pot 4. ./scripts/update_po <your language> NOTE -Doing this manually may result in SVN conflicts when you next 'svn up' with +Doing this manually may result in git conflicts when you next 'git pull' with the repository. The preferred method is to just wait until your PO files are updated for you. @@ -145,6 +145,8 @@ However, the update_pot and update_pot functions from above's step 1-3 are performed in a temporary directory, so buildone_ng.sh cannot be used to update your translation po files! For this, you need to still follow the chapter "Updating your translation". +The intention of buildone_ng.sh is just, to provide an easy method for +translators, to build the manual for testing their translation. Converting an existing translation from .xml files to .po files =============================================================== @@ -289,6 +291,9 @@ If you find any errors in this file, please fix them. -------------------------------------------------------------------------- Changelog: +2018/06/03 Holger Wansing + - Updating (most) content on git migration + 2017-04-12 Holger Wansing - Document new buildone_ng.sh script, to build manual from po files with one command. |