You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@guacamole.apache.org by jm...@apache.org on 2017/02/28 19:10:12 UTC
[1/2] incubator-guacamole-website git commit: GUACAMOLE-224: Update
style guidelines to note that we don't accept "@author".
Repository: incubator-guacamole-website
Updated Branches:
refs/heads/master 97833172a -> 434a74eec
GUACAMOLE-224: Update style guidelines to note that we don't accept "@author".
Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/commit/89534617
Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/tree/89534617
Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/diff/89534617
Branch: refs/heads/master
Commit: 895346173e58be9275226a77cc30d4f87f981bff
Parents: 9783317
Author: Michael Jumper <mj...@apache.org>
Authored: Tue Feb 28 11:04:40 2017 -0800
Committer: Michael Jumper <mj...@apache.org>
Committed: Tue Feb 28 11:04:40 2017 -0800
----------------------------------------------------------------------
guac-style.md | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/89534617/guac-style.md
----------------------------------------------------------------------
diff --git a/guac-style.md b/guac-style.md
index f75f2fa..e5bccb2 100644
--- a/guac-style.md
+++ b/guac-style.md
@@ -80,11 +80,13 @@ Comments and Documentation
* Description of return value.
*/
int fun(int var1, int var2);
-2. There must be no undocumented behavior of functions.
-3. If changes you are making will make parts of the existing manual incorrect,
+2. Do not use the `@author` tag (or similar). The authors of various parts of
+ the codebase should be tracked by git, not by the code itself.
+3. There must be no undocumented behavior of functions.
+4. If changes you are making will make parts of the existing manual incorrect,
you are not expected to update the manual yourself, but **please let us know
so we correct it**.
-4. For C code, local functions should be static and documented locally.
+5. For C code, local functions should be static and documented locally.
Functions, types, etc. which are not local should be declared in an
appropriate header file, and documented within the header file.
[2/2] incubator-guacamole-website git commit: GUACAMOLE-224: Merge
updated style guidelines.
Posted by jm...@apache.org.
GUACAMOLE-224: Merge updated style guidelines.
Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/commit/434a74ee
Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/tree/434a74ee
Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/diff/434a74ee
Branch: refs/heads/master
Commit: 434a74eecc64d353320213b584a776f1785be85f
Parents: 9783317 8953461
Author: James Muehlner <ja...@guac-dev.org>
Authored: Tue Feb 28 11:09:01 2017 -0800
Committer: James Muehlner <ja...@guac-dev.org>
Committed: Tue Feb 28 11:09:01 2017 -0800
----------------------------------------------------------------------
guac-style.md | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
----------------------------------------------------------------------