gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-04-25 01:31:08 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update.

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@14810 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
fedor 2002-10-21 17:33:11 +00:00
parent 9171702fe6
commit 41871213db
1 changed files with 22 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
Documentation/coding-standards.texi
View file

@ -58,8 +58,9 @@ into another language, under the above conditions for modified versions.
* Introduction:: * Introduction::
* ChangeLog Entries:: * ChangeLog Entries::
* Coding Style:: * Coding Style::
* Memory Management:: * Memory Management::
* Error Handling:: * Error Handling::
* Variable Declaration::
* Contributing:: * Contributing::
@end menu @end menu
@ -68,7 +69,7 @@ into another language, under the above conditions for modified versions.
@section Introduction @section Introduction
This document explains the official coding standards which developers This document explains the official coding standards which developers
for GNUstep base should follow. Note that these standards are in addition for GNUstep should follow. Note that these standards are in addition
to GNU coding standards, not a replacement of them. to GNU coding standards, not a replacement of them.
To summarize, always add a ChangeLog message whenever your commit a To summarize, always add a ChangeLog message whenever your commit a
@ -292,7 +293,7 @@ in use.
@end itemize @end itemize
@c ****************************************************************** @c ******************************************************************
@node Error Handling, Contributing, Memory Management, Top @node Error Handling, Variable Declaration, Memory Management, Top
@section Error Handling @section Error Handling
Initialization methods (e.g. -init) should, upon failure to Initialization methods (e.g. -init) should, upon failure to
@ -331,7 +332,21 @@ Java has the "finally" block which is specifically designed for this task. A
similar mechanism exists in libFoundation with the CLEANUP and FINALLY similar mechanism exists in libFoundation with the CLEANUP and FINALLY
blocks. blocks.
@node Contributing, , Error Handling, Top @c ******************************************************************
@node Variable Declaration, Contributing, Error Handling, Top
@section Variable Declaration
All variables should be decalred at the beginning of a block. The new
C99 standard (and gcc 3.X) allow variables to be declared anywhere in
a block, including after executable code. However, in order to be compatible
with older compilers, all GNUstep programs should keep the old behavior.
Certainly we would consider it a bug to introduce code into the
GNUstep libraries which stopped them compiling with one of the
commonly used compilers.
@node Contributing, , Variable Declaration, Top
@section Contributing @section Contributing
Contributing code is not difficult. Here are Contributing code is not difficult. Here are
@ -340,7 +355,7 @@ some general guidelines:
@itemize @bullet @itemize @bullet
@item @item
FSF must maintain the right to accept or reject potential contributions. We maintain the right to accept or reject potential contributions.
Generally, the only reasons for rejecting contributions are cases where Generally, the only reasons for rejecting contributions are cases where
they duplicate existing or nearly-released code, contain unremovable they duplicate existing or nearly-released code, contain unremovable
specific machine dependencies, or are somehow incompatible with the specific machine dependencies, or are somehow incompatible with the
@ -348,7 +363,7 @@ rest of the library.
@item @item
Acceptance of contributions means that the code is accepted for adaptation Acceptance of contributions means that the code is accepted for adaptation
into libgnustep-base. FSF must reserve the right to make various editorial changes into GNUstep. We reserve the right to make various editorial changes
in code. Very often, this merely entails formatting, maintenance of various in code. Very often, this merely entails formatting, maintenance of various
conventions, etc. Contributors are always given authorship credit and shown conventions, etc. Contributors are always given authorship credit and shown
the final version for approval. the final version for approval.
@ -364,7 +379,7 @@ support is strongly encouraged.
@end itemize @end itemize
Extensions, comments, and suggested modifications of existing libgnustep-base Extensions, comments, and suggested modifications of existing GNUstep
features are also very welcome. features are also very welcome.
@bye @bye