PolicyKit: Branch 'master'
david at kemper.freedesktop.org
Tue Jun 19 22:04:22 PDT 2007
HACKING | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
doc/TODO | 5 +++
2 files changed, 83 insertions(+), 2 deletions(-)
diff-tree 5697a8dba0ff4b7cea9bd64d7abaaad9a96e834d (from 4a9962c7748c6f3cdecabcd53e87fbb2ddcb7d2f)
Author: David Zeuthen <davidz at redhat.com>
Date: Wed Jun 20 01:04:17 2007 -0400
update HACKING and TODO
diff --git a/HACKING b/HACKING
index 039dc6a..67445f4 100644
@@ -1,3 +1,81 @@
+ - anonymous checkouts
+ $ git clone git://git.freedesktop.org/git/PolicyKit.git
+ - checkouts if you got an ssh account on fd.o (username@ is optional)
+ $ git clone ssh://[username@]git.freedesktop.org/git/PolicyKit.git
+ - commit to local repository
+ $ git commit -a
+ - push local repository to master repository at fd.o (remember most patches
+ requires review at the mailing list)
+ $ git push
+ - pull changes from master repository at fd.o
+ $ git pull
+ - diff of working tree versus local repository
+ $ git diff
+ - diff of local repository vs. master repository at fd.o
+ synchronize with upstream repo:
+ $ git pull
+ (possibly merge changes)
+ generate the diff:
+ $ git diff origin HEAD
+ - influential environment variables (set these in e.g. .bash_profile)
+ export GIT_AUTHOR_NAME='Your Full Name'
+ export GIT_COMMITTER_NAME='Your Full Name'
+ export GIT_COMMITTER_EMAIL=youremail at domain.net
+ export GIT_AUTHOR_EMAIL=youremail at domain.net
+ - see also
+ - Commit messages should be of the form (the five lines between the
+ lines starting with ===)
+=== begin example commit ===
+short explanation of the commit
+Longer explanation explaining exactly what's changed, whether any
+external or private interfaces changed, what bugs were fixed (with bug
+tracker reference if applicable) and so forth. Be concise but not too brief.
+=== end example commit ===
+ - Always add a brief description of the commit to the _first_ line of
+ the commit and terminate by two newlines (it will work without the
+ second newline, but that is not nice for the interfaces).
+ - First line (the brief description) must only be one sentence and
+ must not start with a capital letter. Don't use a trailing period
+ - The main description (the body) is normal prose and should use normal
+ punctuation and capital letters where appropriate. Normally, for patches
+ sent to a mailing list it's copied from there.
+ - When committing code on behalf of others use the --author option, e.g.
+ git commit -a --author "Joe Coder <joe at coder.org>"
@@ -5,7 +83,7 @@ Coding Style
- Please follow the coding style already used - it's not a must, but it's
nice to have consistency.
- - Write docs for all functions and structs and so on.
+ - Write docs for all functions and structs and so on. We use gtkdoc format.
- All external interfaces (network protocols, file formats, etc.)
should have documented specifications sufficient to allow an
diff --git a/doc/TODO b/doc/TODO
index 3b8700c..c0f0b1f 100644
@@ -1,4 +1,6 @@
+ - Have someone review the external API
- Verify the security model
- Audit all code; especially the setgid helper
@@ -7,7 +9,8 @@
configuration; right now we have the notion of PolicyKit modules;
am almost certain that needs to go. Especially in the light of the
fact that we no longer care about Objects/PolKitResource. Probably
- some simple XML will do; no need to load .so files I think
+ some simple XML will do; no need to load .so files I think. Keep
+ It Simple.
- Granted privileges are currently world-visible; see
More information about the hal-commit