Node:Adding Code, Next:New Ports, Previous:Additions, Up:Additions
You are free to add any new features you like to
However, if you want your changes to be incorporated into the
distribution, there are several steps that you need to take in order to
make it possible for me to include your changes:
gawkitself, consider writing it as an extension module (see Adding New Built-in Functions to
gawk). If that's not possible, continue with the rest of the steps in this list.
gawk. If your version of
gawkis very old, I may not be able to integrate them at all. (See Getting the
gawkDistribution, for information on getting the latest version of
gawk. (The GNU Coding Standards are available from the GNU Project's
ftpsite, at ftp://ftp.gnu.org/gnu/GNUInfo/standards.text. Texinfo, Info, and DVI versions are also available.)
gawkcoding style. The C code for
gawkfollows the instructions in the GNU Coding Standards, with minor exceptions. The code is formatted using the traditional "K&R" style, particularly as regards to the placement of braces and the use of tabs. In brief, the coding rules for
gawkare as follows:
int, on the line above the line with the name and arguments of the function.
forloop initialization and increment parts, and in macro bodies.
'\0'in the conditions of
forstatements, as well as in the
switchstatements, instead of just the plain pointer or character value.
NULLsymbolic constants and the character constant
'\0'where appropriate, instead of
ISDIGIT, etc. macros, instead of the traditional lowercase versions; these macros are better behaved for non-ASCII character sets.
#elif. Many older Unix C compilers cannot handle it.
allocafunction for allocating memory off the stack. Its use causes more portability trouble than is worth the minor benefit of not having to free the storage. Instead, use
If I have to reformat your code to follow the coding style used in
gawk, I may not bother to integrate your changes at all.
@byeat the end of the Texinfo source file. If possible, please update the
manpage as well.
You will also have to sign paperwork for your documentation changes.
diff -c -r -Nor
diff -u -r -Nto compare the original
gawksource tree with your version. (I find context diffs to be more readable but unified diffs are more compact.) I recommend using the GNU version of
diff. Send the output produced by either run of
diffto me when you submit your changes. (See Reporting Problems and Bugs, for the electronic mail information.)
Using this format makes it easy for me to apply your changes to the
master version of the
gawk source code (using
If I have to apply the changes manually, using a text editor, I may
not do so, particularly if there are lots of changes.
ChangeLogfile with your submission. This helps further minimize the amount of work I have to do, making it easier for me to accept patches.
Although this sounds like a lot of work, please remember that while you may write the new code, I have to maintain it and support it. If it isn't possible for me to do that with a minimum of extra work, then I probably will not.