1
0
mirror of https://github.com/moparisthebest/wget synced 2024-07-03 16:38:41 -04:00

[svn] Beautify...

This commit is contained in:
hniksic 2000-11-08 09:11:25 -08:00
parent f306ae9626
commit fa8ded0134

72
PATCHES
View File

@ -1,7 +1,8 @@
* Guidelines for patch submissions * Guidelines for patch submissions.
================================== ===================================
** Where to send the patches. ** Where to send the patches.
-----------------------------
Patches intended to be applied to Wget should be mailed to Patches intended to be applied to Wget should be mailed to
<wget-patches@sunsite.auc.dk>. Each patch will be reviewed by the <wget-patches@sunsite.auc.dk>. Each patch will be reviewed by the
@ -10,14 +11,22 @@ rejected with an explanation.
If you want to discuss your patch with the community of Wget users and If you want to discuss your patch with the community of Wget users and
developers, it is OK to send it to the general list at developers, it is OK to send it to the general list at
<wget@sunsite.auc.dk>. If the patch is really large (more than 100K), <wget@sunsite.auc.dk>. If the patch is really huge (more than 100K or
you may want to put it on the web and post the URL. so), you may want to put it on the web and post the URL.
If your mail composer or gateway is inclined to munge patches, e.g. by EVERY patch should be accompanied by an explanation of what the patch
line-wrapping them, send them out as a MIME attachment. Otherwise, changes, and why the change is necessary. The explanation need not be
patches simply inserted into an email message are fine. long, but please don't just send a patch without any text.
Normally, a patch can be just inserted into the message, after the
explanation and the ChangeLog entry. However, if your mail composer
or gateway is inclined to munge patches, e.g. by line-wrapping them,
please send them out as a MIME attachment. It is important that the
patch survives the travel so that we can feed it to the `patch'
utility after reviewing it.
** How to create patches. ** How to create patches.
-------------------------
Patches are created using the `diff' utility. When making patches, Patches are created using the `diff' utility. When making patches,
please use the `-u' option, or if your diff doesn't support it, `-c'. please use the `-u' option, or if your diff doesn't support it, `-c'.
@ -36,7 +45,7 @@ An example of the `diff' usage:
Also, it is helpful if you create the patch in the top level of Also, it is helpful if you create the patch in the top level of
the Wget source directory: the Wget source directory:
$ cp -p src/http.c src/http.c.orig $ cp src/http.c src/http.c.orig
...hack, hack, hack.... ...hack, hack, hack....
$ diff -u src/http.c.orig src/http.c $ diff -u src/http.c.orig src/http.c
@ -52,42 +61,57 @@ form of a patch. If you really cannot use a variant of `diff', then
mail us the whole new file and specify which version of Wget you mail us the whole new file and specify which version of Wget you
changed; that way we will be able to generate the diff ourselves. changed; that way we will be able to generate the diff ourselves.
Finally, if your changes introduce new files, or if they change the
old files past all recognition (e.g. by completely reimplementing the
old stuff), sending a patch obviously doesn't make sense. In that
case, just attach the files along with an explanation of what is being
changed.
** Standards and coding style. ** Standards and coding style.
------------------------------
Wget abides by the GNU coding standards, available at: Wget abides by the GNU coding standards, available at:
http://www.gnu.org/prep/standards.html http://www.gnu.org/prep/standards.html
The most important point in that entire document is "no arbitrary To me the most important single point in that entire document is "no
limits". Even when Wget's coding is less than exemplary, it respects arbitrary limits". Even when Wget's coding is less than exemplary, it
that rule. There should be no exceptions. respects that rule. There should be no exceptions.
Here is a short recap of the indentation/naming rules, borrowed from Here is a short recap of the GNU formatting and naming conventions,
XEmacs: borrowed from XEmacs:
-- Put a space after every comma. * Put a space after every comma.
-- Put a space before the parenthesis that begins a function call,
* Put a space before the parenthesis that begins a function call,
macro call, function declaration or definition, or control macro call, function declaration or definition, or control
statement (if, while, switch, for). (DO NOT do this for macro statement (if, while, switch, for). (DO NOT do this for macro
definitions; this is invalid preprocessor syntax.) definitions; this is invalid preprocessor syntax.)
-- The brace that begins a control statement (if, while, for, switch,
* The brace that begins a control statement (if, while, for, switch,
do) or a function definition should go on a line by itself. do) or a function definition should go on a line by itself.
-- In function definitions, put the return type and all other
* In function definitions, put the return type and all other
qualifiers on a line before the function name. Thus, the function qualifiers on a line before the function name. Thus, the function
name is always at the beginning of a line. name is always at the beginning of a line.
-- Indentation level is two spaces. (However, the first and following
statements of a while/for/if/etc. block are indented four spaces * Indentation level is two spaces. (However, the first and
from the while/for/if keyword. The opening and closing braces are following statements of a while/for/if/etc. block are indented
indented two spaces.) four spaces from the while/for/if keyword. The opening and
-- Variable and function names should be all lowercase, with closing braces are indented two spaces.)
* Variable and function names should be all lowercase, with
underscores separating words, except for a prefixing tag, which may underscores separating words, except for a prefixing tag, which may
be in uppercase. Do not use the mixed-case convention (e.g. be in uppercase. Do not use the mixed-case convention (e.g.
SetVariableToValue ()) and *especially* do not use Microsoft SetVariableToValue ()) and *especially* do not use Microsoft
Hungarian notation (char **rgszRedundantTag). Hungarian notation (char **rgszRedundantTag).
-- preprocessor and enum constants should be all uppercase, and should
be prefixed with a tag that groups related constants together. * Preprocessor constants and enumerations should be all uppercase,
and should be prefixed with a tag that groups related constants
together.
** ChangeLog policy. ** ChangeLog policy.
--------------------
Each patch should be accompanied by an update to the appropriate Each patch should be accompanied by an update to the appropriate
ChangeLog file. Please don't mail patches to ChangeLog because they ChangeLog file. Please don't mail patches to ChangeLog because they