mirror/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-09-28 08:49:45 +02:00
Code

CodingGuidelines: mention "static" and "extern"

Browse Source 
It perhaps goes without saying that file-local stuff should
be marked static, but it does not hurt to remind people.

Less obvious is that we are settling on "do not include
extern in function declarations". It is already the default
unless the function was previously declared static (but if
you are following a static declaration with an unmarked one,
you should think about why you are declaring the thing
twice). And so it just becomes an extra noise-word in our
header files.

We used to give the opposite advice, so there are quite a
few "extern" markers in early Git code. But this at least
makes a concrete suggestion that we can follow going
forward.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jeff King 2018-02-08 16:38:06 -05:00 committed by Junio C Hamano
parent 5be1f00a9a
commit 89a9f2c862
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/CodingGuidelines
View File

@ -386,6 +386,11 @@ For C programs:
- Use Git's gettext wrappers to make the user interface
translatable. See "Marking strings for translation" in po/README.
- Variables and functions local to a given source file should be marked
with "static". Variables that are visible to other source files
must be declared with "extern" in header files. However, function
declarations should not use "extern", as that is already the default.
For Perl programs:
- Most of the C guidelines above apply.