aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Kangas <skangas@skangas.se>2011-03-08 13:23:08 +0100
committerStefan Kangas <skangas@skangas.se>2011-03-08 13:23:08 +0100
commitf57e381a869095629cb8b006f93b485c8fb5dfeb (patch)
tree3fcb3879fcdb4618a684f9c8c30bd18867a89a06
parentb96a6d1c671afe0f5202a6f895bbc0115d4da877 (diff)
Add note about documenting ones changes
-rw-r--r--fripost-docs.org35
1 files changed, 23 insertions, 12 deletions
diff --git a/fripost-docs.org b/fripost-docs.org
index e5756fd..f5e6900 100644
--- a/fripost-docs.org
+++ b/fripost-docs.org
@@ -765,22 +765,33 @@ TODO: Add nice rules.
* NEED TO KNOW FOR SERVER ADMINS
+** Document your changes
+
+When you make changes to the system, document them here.
+
+The latest version of this document is always available from:
+
+ git clone git://github.com/skangas/fripost-docs.git
+
+Direct all patches to skangas@skangas.se. Preferably you should use
+`git-format-patch' and `git-send-email'. Thanks.
+
** Use etckeeper
- We keep /etc in a git repository using the tool etckeeper.
+We keep /etc in a git repository using the tool etckeeper.
- This means that every time you make changes to any files in /etc, you are
- expected to commit them using a descriptive commit message. Please add a
- signature (initials or your username) since all commits will be made as root.
+This means that every time you make changes to any files in /etc, you are
+expected to commit them using a descriptive commit message. Please add a
+signature (initials or your username) since all commits will be made as root.
- $ etckeeper commit "postfix: enable to relay messages to remote hosts via smtp /skangas"
+$ etckeeper commit "postfix: enable to relay messages to remote hosts via smtp /skangas"
- If you do not commit your changes, the next system upgrade will fail and
- whoever makes the upgrade will have to commit your changes for you. They may
- have to guess as to why you made your changes. Please do not put your
- co-administrators in this uncomfortable position.
+If you do not commit your changes, the next system upgrade will fail and
+whoever makes the upgrade will have to commit your changes for you. They may
+have to guess as to why you made your changes. Please do not put your
+co-administrators in this uncomfortable position.
- It is also possible to use simple git commands in /etc, e.g. `git log'.
- `etckeeper' has the benefit of keeping track of file permissions, which git
- by itself will not.
+It is also possible to use simple git commands in /etc, e.g. `git log'.
+`etckeeper' has the benefit of keeping track of file permissions, which git
+by itself will not.