From ae117ea20b9a9be96bbddc0d8cf2ccbdfcf7b2a3 Mon Sep 17 00:00:00 2001 From: Brad Hards Date: Sun, 29 Nov 2009 11:47:40 +1100 Subject: [PATCH 1/2] Minor doco cleanup. --- HACKING | 12 ++++++------ 1 files changed, 6 insertions(+), 6 deletions(-) diff --git a/HACKING b/HACKING index da93ea0..d531294 100644 --- a/HACKING +++ b/HACKING @@ -14,7 +14,7 @@ Working in libgsf 5) Fast When you submit code to inclusion in libgsf, or when you modify the sources -directly on the CVS repository, please keep those things in mind. While +directly on the Git repository, please keep those things in mind. While performance is important please note that we do not want to hand tune code to shave milliseconds at this point. Well designed algorithms and data strucutures are fertile areas for development, obfuscated code to make a @@ -31,7 +31,7 @@ Formatting style yourself familiar with the GNU coding standards (shipped with most GNU/Linux systems as the standards.info file), then read the Linux kernel coding standards and ignore Linus' jokes. Then look at the -Gtk+ header files to get aquainted on how to write nice header files +Gtk+ header files to get acquainted on how to write nice header files that are almost self documenting. Remember: Use 8 space tabs for indentation: that will keep your @@ -52,13 +52,13 @@ modular chunks (as detailed by Linus). - Make sure your code does not have a single warning (with the default strong warnings that Gnumeric compiles with) before - your code is submited. (Although we do not advocate -Werror) + your code is submitted. (Although we do not advocate -Werror) - Every entry point to a public routine should use the g_return_if_fail and g_return_val_if_fail macros to verify that the parameters passed are valid. - - Under no circunstances use magic variables. Use typedef + - Under no circumstances use magic variables. Use typedef enum { ... } type; to create enumerations. Do not use integers to hold references to enumerations, the compiler can help catch various errors. @@ -75,7 +75,7 @@ modular chunks (as detailed by Linus). - It is more important to be correct than to be fast. - - Do not optimize unnecesarly. Do profile, do look for the + - Do not optimize unnecessarily. Do profile, do look for the weak spots before applying "optimization by feeling". This is not a Ouija-based project. @@ -98,7 +98,7 @@ reasonable margins of maintainability for the future: Remember, in two years you will probably be far too busy to maintain your own contributions, and they might become a burden to the program maintainers. - libgsf is intented to be a foundation for a various document centric + libgsf is intended to be a foundation for a various document centric projects. Cleaning code in libgsf is more important than trying not to break -- 1.6.2.5