1
0
mirror of https://github.com/nmap/nmap.git synced 2025-12-06 04:31:29 +00:00

Updated information and procedures from the project's HACKING file.

This commit is contained in:
henri
2012-07-09 22:53:46 +00:00
parent 8bbaa0c91c
commit 113f1791ff

52
HACKING
View File

@@ -36,20 +36,27 @@ your proposals. List members are often very willing to help. You
might want to subscribe to that mailing list as well -- send a blank might want to subscribe to that mailing list as well -- send a blank
email to nmap-dev-subscribe@insecure.org . While you are at it, you email to nmap-dev-subscribe@insecure.org . While you are at it, you
might also want to subscribe to nmap-hackers via the same mechanism. might also want to subscribe to nmap-hackers via the same mechanism.
Web archives of those lists are at http://lists.insecure.org . Web archives of those lists are at http://seclists.org .
Some ideas of useful contributions/projects Some ideas of useful contributions/projects
------------------------------------------- -------------------------------------------
Of course, you are welcome to work on whatever suits your fancy. But Of course, you are welcome to work on whatever suits your fancy. But
here are some ideas of contributions that might be particularly some ideas of contributions that might be particularly useful are listed in
useful: the todo file, available in todo/nmap.txt or online at
https://svn.nmap.org/nmap/todo/nmap.txt
o Script ideas page. Writing NSE scripts is an excellent way to contribute to
the project. You can add your script ideas to our wiki page, or pick one and
implement it. See: https://secwiki.org/w/Nmap_Script_Ideas
o Nmap GUI improvements -- Zenmap is the Nmap GUI. If you have o Nmap GUI improvements -- Zenmap is the Nmap GUI. If you have
enhancement ideas, give it a shot! Alternatively, consider enhancement ideas, give it a shot! Alternatively, consider
contributing to the NmapGUI and Umit projects available at contributing to the NmapSI and Umit projects available at
http://sourceforge.net/projects/nmapgui/ and http://www.nmapsi4.org and http://umit.sourceforge.net respectively.
http://umit.sourceforge.net/ , respectively. There are also other satellite projects, with different level of activity,
such as NmapGUI (http://sourceforge.net/projects/nmapgui) or Nmap::parser
(http://rubynmap.sourceforge.net).
One of the best ways to help is to join the nmap-dev list One of the best ways to help is to join the nmap-dev list
( http://cgi.insecure.org/mailman/listinfo/nmap-dev ). Requests for ( http://cgi.insecure.org/mailman/listinfo/nmap-dev ). Requests for
@@ -59,37 +66,20 @@ How to make code contributions
------------------------------ ------------------------------
The preferred mechanism for submitted changes is unified diffs against The preferred mechanism for submitted changes is unified diffs against
the latest development release version of Nmap. Please send them to the latest SVN trunk. Please send them to nmap-dev@insecure.org .
nmap-dev@insecure.org .
To make a unified diff, please follow these instructions: Get a local copy of the SVN trunk:
1. Remove temporary files: svn co https://svn.nmap.org/nmap
make clean
2. Rename your source tree: Make your changes.
cd ..
mv nmap-5.21 nmap-5.21-snazzy-feature
3. Unpack the original Nmap source alongside it: Then make a unified diff, by issuing the following command:
tar xzf nmap-5.21.tgz
4. Generate the diffs: svn diff > nmap.patch
diff -urNb nmap-5.21 nmap-5.21-snazzy-feature > nmap.patch
5. Check the patch and remove any unnecessary patches from the file. If you've added several features, it's best to send them as several independent
patches if you can.
6. If you've added several features, it's best to send them as
several independent patches if you can.
If you have just patched one or two files, then making patches is even
easier. For each file, just do:
cp file.c file.c.orig
[Make changes to file.c ...]
diff -u file.c.orig file.c > file.c.patch
and just send us the patch: file.c.patch.
Style Style
----- -----