Various corrections and updates
authorjake <jake@f5534014-38df-0310-8fa8-9805f1628bb7>
Fri, 23 Jun 2006 06:14:30 +0000 (06:14 +0000)
committerjake <jake@f5534014-38df-0310-8fa8-9805f1628bb7>
Fri, 23 Jun 2006 06:14:30 +0000 (06:14 +0000)
git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@18553 f5534014-38df-0310-8fa8-9805f1628bb7

docbook/developer-guide.xml
docbook/wsdg_src/WSDG_chapter_build_intro.xml
docbook/wsdg_src/WSDG_chapter_env_intro.xml
docbook/wsdg_src/WSDG_chapter_sources.xml

index 7879ea121c26b89e61f5805418901a5f89d2ed07..aadc06218629263fad52774062de6ef5c8f97e34 100644 (file)
@@ -47,12 +47,12 @@ Wireshark Info
 -->
   <!ENTITY WiresharkCurrentVersion "0.99.0">
   <!ENTITY WiresharkWebSite "http://www.wireshark.org">
-  <!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download.html">
-  <!ENTITY WiresharkAuthorsPage "&WiresharkWebSite;/introduction.html#authors">
+  <!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download/">
+  <!ENTITY WiresharkAuthorsPage "http://anonsvn.wireshark.org/wireshark/trunk/AUTHORS">
   <!ENTITY WiresharkFAQPage "&WiresharkWebSite;/faq.html">
   <!ENTITY WiresharkDevMailList "wireshark-dev[AT]wireshark.org">
-  <!ENTITY WiresharkDevsGuidePage "&WiresharkWebSite;/docs">
-  <!ENTITY WiresharkUsersGuidePage "&WiresharkWebSite;/docs">
+  <!ENTITY WiresharkDevsGuidePage "&WiresharkWebSite;/docs/">
+  <!ENTITY WiresharkUsersGuidePage "&WiresharkWebSite;/docs/">
   <!ENTITY WiresharkWikiSite "http://wiki.wireshark.org">
   <!ENTITY WiresharkBugsSite "http://bugs.wireshark.org">
 
index c3ee70fd9a15853b215cb42bb22988925be64b64..f6da712b5b769807155547aabd4e07c63fbe7b28 100644 (file)
@@ -10,7 +10,7 @@
        Wireshark consists of the following major parts:
        <itemizedlist>
        <listitem><para>
-       Packet dissection - in the / and /epan directory
+       Packet dissection - in the /epan/dissector and /plugin/* directory
        </para></listitem>
        <listitem><para>
        File I/O - using Wireshark's own wiretap library
@@ -30,7 +30,7 @@
        <para>
        Currently there's no clean seperation of the modules in the code. 
        However, as the development team switched from CVS to SVN some time ago, 
-       directory cleanup are much easier now. So there's a chance that
+       directory cleanup is much easier now. So there's a chance that
        the directory structure will become clean in the future.
        </para>
   </section>
index dac6db54ea415e316f2eb33372edf9dde8828e66..13493521a442a58630651e43067ccf1089cc5f12 100644 (file)
 
        <section id="ChIntroBugDatabase"><title>Bug database</title>
        <para>
-       The Etereal community started collecting bug reports in a Bugzilla database at
+       The Wireshark community started collecting bug reports in a Bugzilla database at
        <ulink url="&WiresharkBugsSite;">&WiresharkBugsSite;</ulink>.
        This database is filled with manually filed bug reports, usually after some 
        discussion on wireshark-dev, and bug reports from the QA build tooling.
        If you report problems, provide as much 
        information as possible. In general, just think about what 
        you would need to find that problem, if someone else sends you such a 
-       problem report. Also keep in mind, that people uses a lot of different 
+       problem report. Also keep in mind, that people use a lot of different 
        platforms to compile/run Wireshark on. 
     </para>
     <para>
index 0f8ec68625c0a8ac122fc4c84d968a3576a4a490..9aa5ac2fd85584b28c238d33af4087272c2edddc 100644 (file)
        The buildbot server will automatically start to generate a snapshot of 
        Wireshark's sourcetree after a source code change committed. 
        These snapshots can be found at: <ulink
-       url="http://www.wireshark.org/distribution/buildbot-builds/source/"/>.
+       url="&WiresharkDownloadPage;automated/src/"/>.
        </para>
        <para>
        If anonymous Subversion access isn't possible, e.g. if the connection to 
        </para>
        <para>
        The officially released source files can be found at: <ulink
-       url="http://www.wireshark.org/download.html"/>.
+       url="&WiresharkDownloadPage;"/>.
        You should use these sources if you want to build Wireshark on your
        platform for productive use.
        </para>
@@ -579,7 +579,12 @@ diff -ur ../wireshark-0.99.0/epan/dissectors/packet-dcerpc.c ./epan/dissectors/p
        <userinput>svn diff [changed_files] > svn.diff</userinput>
        </para>
        <para>
-       XXX - add more details
+       Use the command line svn client to generate a patch in the required format 
+       from the changes you've made to your working copy. If you leave out the 
+       name of the changed file the svn client searches for all changes in the 
+       working copy and usually produces a patch containing more than just the 
+       change you want to send. Therefore you should always check the produced 
+       patch file.
        </para>
        </section>
 
@@ -781,7 +786,7 @@ diff -ur ../wireshark-0.99.0/epan/dissectors/packet-dcerpc.c ./epan/dissectors/p
          and the fuzz test randomly change bytes in this file, so unconditional 
          code paths in your dissector are passed. There are tools available to 
          automatically do this on any number of input files, see: 
-         <ulink url="http://wiki.wireshark.org/FuzzTesting"/> for details.
+         <ulink url="&WiresharkWikiSite;/FuzzTesting"/> for details.
          </para>
          </listitem>
        </itemizedlist>
@@ -792,11 +797,11 @@ diff -ur ../wireshark-0.99.0/epan/dissectors/packet-dcerpc.c ./epan/dissectors/p
        <title>Sending your patch to the developer mailing list</title>
        <para>
        After generating a patch of your changes, you might want to have your
-       changes included into the SVN server.
+       changes included into the SVN repository.
        </para>
        <para>
        You should send an email to <ulink
-       url="mailto:wireshark-dev[AT]wireshark.org"/> containing: 
+       url="mailto:&WiresharkDevMailList;"/> containing: 
        <itemizedlist>
          <listitem><para>
          subject: [PATCH] and a short description of your changes
@@ -856,10 +861,8 @@ diff -ur ../wireshark-0.99.0/epan/dissectors/packet-dcerpc.c ./epan/dissectors/p
        of the patch and your source files match.
        </para>
        </warning>
-       <para>
-       XXX - the following is a collection of material and needs some 
-       clarification.
-       </para>
+       <section id="ChSrcPatchUse">
+       <title>Using patch</title>
        <para>
        Given the file "new.diff" containing a unified diff, the right way to 
        call the patch tool depends on what the pathnames in "new.diff" look like.
@@ -906,6 +909,9 @@ diff -ur ../wireshark-0.99.0/epan/dissectors/packet-dcerpc.c ./epan/dissectors/p
        that - especially if they're only patching files that exist in multiple 
        directories, such as "Makefile.am".
        </para>
+       </section>
+       <section id="ChSrcPatchCvs">
+       <title>CVS diff (obsolete)</title>
        <para>
        One other thing to note - "cvs diff" produces output that at least some
        versions of "patch" can't handle; you'd get something such as
@@ -946,9 +952,7 @@ diff -c -r1.5 dlnames.c
        doesn't have that problem.  Regular "diff -c" or "diff -u" output also
        shouldn't have that problem.
        </para>
-       <para>
-       XXX - add some more details and do some cleanup.
-       </para>
+       </section>
   </section>
 
   <section id="ChSrcAdd">
@@ -979,7 +983,7 @@ diff -c -r1.5 dlnames.c
        Add a line to each new file, containing the following text (case is 
        important, so don't write ID or id or iD):
 <programlisting>
-$Id:$
+$Id&#36;
 </programlisting>
        </para>
        </listitem>
@@ -1049,7 +1053,7 @@ $Id:$
        <section id="ChSrcNSIS">
        <title>Win32: NSIS .exe installer</title>
        <para>
-       The "Nullsoft Install System" is a free installer generator for win32
+       The "Nullsoft Install System" is a free installer generator for Win32
        based systems, instructions how to install it can be found in <xref 
        linkend="ChToolsNSIS"/>. 
        NSIS is script based, you will find the Wireshark installer