Ubuntu Wiki

This page is in progress, and is not yet complete. It is also not linked from anywhere yet.

This page contains tips, how-to notes and examples for documentation committers working with the serverguide. Intended as a supplement to, and not a replacement for, the generic Members page.

Executing a Merge Proposal

Once a merge proposal has been accepted, it needs to be merged into the main branch:

1. Set up a local working branch:

   mkdir sguide-1204
   cd sguide-1204
   bzr branch lp:serverguide/precise mp_100000
   cd mp_100000 

2. Always run the validate script before any changes, just in case something is wrong:

   scripts/validate.sh serverguide/C/serverguide.xml 

3. Perform the actual merge and do some checks:

   bzr merge lp:~jdoe/serverguide/some-review
   scripts/validate.sh serverguide/C/serverguide.xml
   bzr diff | more   (some prefer 'bzr cdiff' (from the package 'bzrtools'))
   make serverguide-html
   make serverguide-pdf
   bzr status     (for a summary of the current merge proposal) 

4. Once everything is in order, which it should be for an approved merge proposal, then complete the job:

   bzr commit --fixes lp:123456 -m 'Edits per MP: #100000; LP: #123456 some notes about whatever; by John Doe'
   bzr push lp:serverguide/precise 

Note that if working with the current release cycle branch the "lp:serverguide" can be used instead of "lp:serverguide/branch_name"

Updating the .po files

When the bzr branch .po files need to be updated:

1. Create a working branch

   bzr branch lp:serverguide/precise precise_po_update 

2. Ask for the entire po set via https://translations.launchpad.net/serverguide/precise/+export

3. Wait for the e-mail to come saying that the .po set is ready.
4. Get and unpack the file set to some location.

5. The file names will be serverguide-LN.po (where LN is each lanaguage), but they need to be LN.po:

   rename 's/(serverguide-)(.*)\.po/$2.po/' *.po 

6. Check that the po files are actually newer and that the number of files is the same.

   grep PO-Rev *.po | more 

7. Replace the old .po files with the newer ones. (Do NOT copy the .pot file from the downloaded file set.)

8. Check bzr status, commit and push the branch:

   bzr status
   bzr commit -m 'update the po files; by John Doe'
   bzr push lp:serverguide/precise 

Updating the .pot file

Members of the ubuntu-core-doc team can publish their changes directly to the branches. This is the procedure:

1. First, update your branch to the current version by running

   bzr pull lp:~ubuntu-core-doc/ubuntu-docs/name_of_branch

   • Note: please do not use bzr merge for updating your branch.

2. Then make your changes and commit them with

   bzr commit -m "Description of changes"

   • Note: it is helpful if the description of the changes uses a short description that can later be used in the changelog for the package. If a bug is fixed, please include the bug number in the description in this format: LP: #bugnumber. You can also associate the branch with the bug in Launchpad by including this in your commit command: --fixes lp:bugnumber

3. Then push your commit to the common branch by running

   bzr push lp:~ubuntu-core-doc/ubuntu-docs/name_of_branch

We recommend that members use the concept of Bound Branches so that the bzr commit command sends your changes directly to the appropriate branch on Launchpad. That will avoid the need for step 3 above. You can bind a branch by running

bzr bind lp:~ubuntu-core-doc/ubuntu-doc/name_of_branch

For more information about using bound branches, see the bzr website.