Difference between revisions of "Howto:Remplir le Changelog"

Latest revision as of 21:18, 25 August 2014

Cette page est un brouillon en cours de rédaction.

Sur chaque machine, on a un fichier Changelog pour garder une trace des opérations effectuées.

Création du fichier

Par habitude, on trouve ce fichier dans /root/Changelog (grand C, petit L).

# touch /root/Changelog

Pour que les sysadmins puissent le lire et l'éditer, on modifie quelques droits :

# chgrp adm /root /root/Changelog
# chmod g+x /root
# chmod g+rw /root/Changelog

Et pour les prochains utilisateurs, on crée un lien convivial :

# ln -s /root/Changelog /etc/skel/Changelog

Configuration de l'éditeur

vim

On va configurer le plugin changelog^[1] de vim pour avoir la coloration syntaxique et des raccourcis clavier bien pratiques.

Par défaut, Debian et Ubuntu installent le paquet vim-tiny, une version allégée de vim, qui ne supporte pas cette fonction. On remplace donc vim-tiny par un vim potable :

apt-get install vim-tiny- vim

Puis dans ${HOME}/.vimrc :

# Attention, deux espaces pour séparer nom et adresse mail
let g:changelog_username = 'ToM  <tom@leloop.org>'

# Pour que vim reconnaisse un fichier Changelog comme tel
filetype plugin on

# Et pour faire joli
syntax enable

Désormais, lorsqu'on ouvre un fichier détecté comme Changelog, il suffit de faire <Leader> o pour ouvrir une nouvelle entrée de Changelog.

Par défaut, <Leader> est \ (backslash).

emacs

<TBD>

Remplir le Changelog

<à compléter>

On y décrit chacune des opérations effectuées. Il ne s'agit pas de recopier la doc, mais d'indiquer quand, qui, quoi et à quel endroit. L’idée est qu'en cas de question, on devrait pouvoir trouver l'essentiel d'un simple grep KEYWORD Changelog.

Pour l'exemple, on va y documenter ce qu'on vient de faire ! Deux tâches ont été effectuées, d'où les deux groupes :

• configuration de vim
• configuration du Changelog

2014-08-19  ToM  <tom@leloop.org>

       * dpkg: purge vim-tiny, install vim
       * editor (vim): configuration globale
       (/etc/vim/vimrc.local)
       * editor: update-alternative editor=vim

       * root: chgrp adm, g=rx, Changelog
       (/root, /root/Changelog)
       * skel: ajout d'un lien vers /root/Changelog
       (/etc/skel/Changelog)

Particularités

modeline

Considérons cette partie :

       * editor (vim): configuration globale
       (/etc/vim/vimrc.local)

Normalement, on aurait dû écrire :

       * vim: configuration globale
       (/etc/vim/vimrc.local)

Sauf que la séquence vim: serait alors interprétée comme une modeline. On pourrait compléter la configuration pour prendre en compte ce cas, mais pour le peu de fois où ça arrive, dans l'état ça fait le job : on trouvera cette entrée avec un grep et c'est là l'essentiel.

Exemples

Pris sur des vraies machines, avec de vrais Changelogs remplis par de vrais admins — parfois en mousse authentique.

Des fois on note un truc pour se rappeler plus tard comment on s'y est pris :

2013-09-13  ToM  <tom@leloop.org>

       * mysql: dont start on boot
       echo 'manual' | sudo tee -a /etc/init/mysql.override

       * firefox: passage à DuckDuckGo par défaut, ouverture des recherches dans
       un nouvel onglet.
       (browser.search.defaultenginename, browser.search.openintab)
       * firefox: Passage de browser.xul.error_pages.expert_bad_cert à true.
       Ainsi la section "Je comprends les risques" sera dépliée directement, ce
       qui économise au moins un clic. Astuce trouvée dans le source de la page
       aboutCertError.xhtml.

Ou pour se souvenir de pourquoi on installe tel ou tel truc :

       * dpkg: install ttf-mscorefonts-installer
       I HAZ IMPACT FONT LOL

Des fois c'est juste pour laisser un message :

2012-09-04  okhin  <okhin@leloop.org>

       * http: apache sert le http, nginx le https. J'ai pleuré.

Références

1. ↑ Voir /usr/share/vim/vim73/ftplugin/changelog.vim pour plus de détails.