From Mageia wiki
Jump to: navigation, search


Drakconf multiflag.png
Other languages
Deutsch ; English ; français ;

Instructions

    1. Get a local copy of the repository to work on:
    2. git clone mga:software/drakx-installer-help
    3. Update files in drakx-installer-help/
      • for a new .html file, add an entry in Makefile, HTML_FILES section (preferably in the alphabetical order)
      • for new languages add an entry to Makefile, TRANSLATIONS section
      • for PNG_FILES add an entry to PNG_FILES
        • commit (do several commits with some changes, when there are many changes)
    4. update NEWS with changes that had been done
      • commit (git ci -m "<commit message>")
    5. bump version in Makefile
      • commit
      • git push
      • type "git tag x.y" (replace x.y with version)
      • and then do "git push --tags"
    1. mgarepo co drakx-installer-help
      • update .spec
        • Make sure to add new languages to the «for lang in » loop
      • put .tar.xz into SOURCES/
        • mgarepo sync -d to download the the tarball from git repository
        • do not remove the old tarball (the sha1.lst won't be updated if you remove it before "mgarepo sync")
        • mgarepo sync
        • commit
    2. submit
  1. If everything is fine, then bump release in drakx-installer-stage2 and push (commit message: "rebuild against new drakx-installer-help")

How to get the needed help files from Calenco

To do first

Check with xxe whether DrakX.xml is valid (if you open DrakX.xml in xxe, it will check all pages that are included). If it is not valid, then fix that first.

To do when DrakX.xml is valid

  • go to the needed language space in Calenco
  • choose "Manuals" in the left column
  • select "DrakX.xml" on the right
  • click "Publications" in the menu bar
  • select "DrakX-DE" (replace "DE" with your language code.. for English, it is just "DrakX")
  • in the pop-up, choose "Save File"
  • do not save it in the same place as your copy of git repository, it will be easier to commit separated pieces.

What to check before committing the files

  • unpack the zipped manual you downloaded
  • do git pull in your local copy of git://git.mageia.org/soft/drakx-installer-help/
    • if you don't have that copy yet, do git clone mga:software/drakx-installer-help
  • compare the unpacked files with those in the corresponding git directory with kdiff3 or a similar tool
    • it is often best to first compare the directories and then the changed files in it
  • if everything is OK, copy the new or changed files into the matching directory of your git copy
    • do a last check with git status and by testing the files in a browser
    • or skip the last step, and check with gitk after doing git add for all updated and new files
      • don't git add and then commit too many changes at one time. When the changes aren't too large, it is fine to commit one language at a time, if there is just one string that changed in several or all languages, it is fine to commit that for all those languages. When there are large changes in some pages, it is probably better to commit them one page at a time


Note:
It might look silly to do so many checks. Please keep in mind that we can't correct mistakes that are found when a new version of Mageia has been released. If, for instance, we accidentally overwrite the help for one language with the help for another language, fixing has to wait till next Mageia release. Besides, this was originally written at a time that the diffs were full of useless changes in whitespace etc, so the real changes were very hard to see.
Note:
Now that we seem to have normal diffs, instead of the confusing ones about lots of uselessly changed tabs, spaces and newlines, only one check with gitk might be enough?? And downloading and unpacking the files directly in your local git copy? (after doing git up, of course.)