summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamuel Thibault <samuel.thibault@ens-lyon.org>2018-06-03 21:35:58 +0200
committerSamuel Thibault <samuel.thibault@ens-lyon.org>2018-06-03 22:32:31 +0200
commitc1732322a1e370a7ca92335718c4703fa325ae77 (patch)
treeb659b36519c6566ded795c68414bcb6064da4b74
parentc759dcbb5b8ff45c0d2da5eaab1e7d3a57c47061 (diff)
downloadinstallation-guide-c1732322a1e370a7ca92335718c4703fa325ae77.zip
Update some docs to git workflow
-rw-r--r--debian/changelog1
-rw-r--r--doc/releasing.txt17
-rw-r--r--doc/translations.txt18
-rw-r--r--doc/translations_po.txt13
-rwxr-xr-xscripts/cp-untrans2
-rwxr-xr-xscripts/xml-rename2
6 files changed, 27 insertions, 26 deletions
diff --git a/debian/changelog b/debian/changelog
index 543aa40ee..0f41235f3 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -9,6 +9,7 @@ installation-guide (2017XXXX) UNRELEASED; urgency=medium
* Use https anonscm URL
* Fix URL for development version.
* source/options: Ignore .git directory when building tarball.
+ * Update some docs to git workflow.
[ Holger Wansing ]
* Update Linux Foundation's URL for FHS. Closes: #865981
diff --git a/doc/releasing.txt b/doc/releasing.txt
index 282af8608..03a8d61fe 100644
--- a/doc/releasing.txt
+++ b/doc/releasing.txt
@@ -2,7 +2,7 @@ This document briefly describes how to make a installation-guide release.
- First make sure to be up to date
- svn up
+ git pull
- Set the release date
@@ -12,17 +12,10 @@ This document briefly describes how to make a installation-guide release.
- Commit that
- svn commit
+ git commit
- and remember the commit number (say, 12345)
+- Build (use a machine with a lot of cores to make this fast)
-- Prepare a bare tree
-
- svn export $PWD /tmp/manual-build
-
-- Build from it (use a machine with a lot of cores to make this fast)
-
- cd /tmp/manual-build
pdebuild
- Compare against a previous version to make sure we didn't mess it up
@@ -34,4 +27,6 @@ This document briefly describes how to make a installation-guide release.
- When ACCEPTed, Tag the commit:
- svn cp svn+ssh://svn.debian.org/svn/d-i/trunk/manual@12345 svn+ssh://svn.debian.org/svn/d-i/tags/manual/2017XXXX
+ git tag 2017XXXX
+ git push
+ git push --tags
diff --git a/doc/translations.txt b/doc/translations.txt
index 83b55ac12..e2b81a5ad 100644
--- a/doc/translations.txt
+++ b/doc/translations.txt
@@ -34,7 +34,7 @@ How to start a new translation
==============================
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;
+repository really is not practical. See the section on getting GIT access below;
you will also have to get a local working copy of the manual as described there.
1. Create a new directory structure for your translation
@@ -138,22 +138,23 @@ scripts should be run from this directory.
The procedure below can be used for relatively simple changes. If there
have been major reorganizations in the English documents, you may have to
do additional checks to find out exactly what changes have been made.
-Use 'svn st -u' before you start this procedure to check the status of
+Use 'git status' before you start this procedure to check the status of
your working copy.
- 1. Update your local working copy from SVN
+ 1. Update your local working copy from GIT
------------------------------------------
- change directory to: ./manual/
- - svn up
+ - git pull
2. Copy new files (if any)
--------------------------
- If there are any new files (marked 'A' in the output from 'svn up'),
+ If there are any new files (appearing with "create mode" in the output from
+ 'git pull'),
copy them to the directory for your translation and then:
- ./scripts/rev-update <lang>
This will change the revision comment in the copied file to:
<!-- original version: ##### untranslated -->
- You will also have to run 'svn add' for the new documents.
+ You will also have to run 'git add' for the new documents.
3. Check for other changes
--------------------------
@@ -174,7 +175,7 @@ your working copy.
after you updated a translation. The revision number should be the same
as the revision number in the new version of the English document.
You should run './scripts/doc-check <lang>' again after you finish all updates
- and before you commit your changes to SVN; there should be no output.
+ and before you commit your changes to GIT; there should be no output.
Other uses of the scripts
-------------------------
@@ -266,6 +267,9 @@ are probably errors. Please fix it if you find errors.
--------------------------------------------------------------------------
Changelog:
+2018-06-03 Samuel Thibault
+ - migrate to git
+
2010-05-01 Tapio Lehtonen
- Typo fixes
diff --git a/doc/translations_po.txt b/doc/translations_po.txt
index 1657de81b..b6de69bbf 100644
--- a/doc/translations_po.txt
+++ b/doc/translations_po.txt
@@ -180,7 +180,7 @@ It takes German (de) as an example for the conversion.
3) Run the following scripts:
'./scripts/merge_xml en' # merge English XML files per chapter
'./scripts/update_pot' # update POT files to match merged XML files
- This will create your base situation for conversion. Do _not_ 'svn up'
+ This will create your base situation for conversion. Do _not_ 'git pull'
after this or you may have to start from scratch.
4) Merge XML files for the translation:
@@ -239,7 +239,7 @@ It takes German (de) as an example for the conversion.
9) After you are happy with the conversion, run
'.scripts/create_xml de'
This will generate XML files in ./de.new (not in ./de as that directory
- is still in SVN). This should be without any errors.
+ is still in GIT). This should be without any errors.
Possible errors:
@@ -271,10 +271,10 @@ It takes German (de) as an example for the conversion.
that do not (apparently) affect the building for HTML format.
11) If all is correct, go back to the original "manual/" dir:
- 'svn revert -R po/pot/'
- 'svn add po/de/'
- 'svn del de'
- 'svn ci'
+ 'git checkout -f po/pot/'
+ 'git add po/de/'
+ 'git rm -r de'
+ 'git commit'
'rm -r ./integrated/ ./de.new/'
Note
@@ -292,6 +292,7 @@ If you find any errors in this file, please fix them.
Changelog:
2018/06/03 Holger Wansing
+ Samuel Thibault
- Updating (most) content on git migration
2017-04-12 Holger Wansing
diff --git a/scripts/cp-untrans b/scripts/cp-untrans
index 065be19f4..be080f714 100755
--- a/scripts/cp-untrans
+++ b/scripts/cp-untrans
@@ -6,7 +6,7 @@
# Note:
# Run doc-check before you run this script.
-# It is recommended you use 'svn diff <language>' to check the
+# It is recommended you use 'git diff <language>' to check the
# changes made by this script before committing.
set -e
diff --git a/scripts/xml-rename b/scripts/xml-rename
index 0f7f2af23..03444293f 100755
--- a/scripts/xml-rename
+++ b/scripts/xml-rename
@@ -22,5 +22,5 @@ fi
for FILE in */$SOURCE; do
FDIR="$(dirname $FILE)"
- svn mv $FILE $FDIR/$NEWNAME
+ git mv $FILE $FDIR/$NEWNAME
done