diff options
author | Ulf Lamping <ulf.lamping@web.de> | 2005-07-19 20:06:19 +0000 |
---|---|---|
committer | Ulf Lamping <ulf.lamping@web.de> | 2005-07-19 20:06:19 +0000 |
commit | efe2fb62ccaf415681b59f637d69e2d4dc72fef0 (patch) | |
tree | ed522a1abfc04f9a28c44c885baa2d421b0841e7 /docbook | |
parent | 05e8481eed9687415643b64b3ae7939fc878efa2 (diff) |
from Jaap Keuter: "Syncing info from User Guide into Dev Guide"
svn path=/trunk/; revision=14955
Diffstat (limited to 'docbook')
-rw-r--r-- | docbook/developer-guide.xml | 11 | ||||
-rw-r--r-- | docbook/edg_src/EDG_chapter_env_intro.xml | 82 | ||||
-rw-r--r-- | docbook/edg_src/EDG_preface.xml | 12 |
3 files changed, 82 insertions, 23 deletions
diff --git a/docbook/developer-guide.xml b/docbook/developer-guide.xml index 7e5427afc8..de8222083c 100644 --- a/docbook/developer-guide.xml +++ b/docbook/developer-guide.xml @@ -42,18 +42,23 @@ DOCUMENT SECTION <!ENTITY DocumentLegalNotice "<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.</para><para>All logos and trademarks in this document are property of their respective owner.</para>"> +<!-- +Ethereal Info +--> + <!ENTITY EtherealCurrentVersion "0.10.9"> <!ENTITY EtherealWebSite "http://www.ethereal.com"> <!ENTITY EtherealDownloadPage "&EtherealWebSite;/download.html"> <!ENTITY EtherealAuthorsPage "&EtherealWebSite;/introduction.html#authors"> <!ENTITY EtherealFAQPage "&EtherealWebSite;/faq.html"> <!ENTITY EtherealDevMailList "ethereal-dev[AT]ethereal.com"> <!ENTITY EtherealUsersGuidePage "&EtherealWebSite;/docs/#usersguide"> - <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html"> + <!ENTITY EtherealWikiSite "http://wiki.ethereal.com"> + <!ENTITY EtherealBugsSite "http://bugs.ethereal.com"> <!-- -Ethereal Info +Gnu info --> - <!ENTITY EtherealCurrentVersion "0.10.9"> + <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html"> <!-- FILE SECTION diff --git a/docbook/edg_src/EDG_chapter_env_intro.xml b/docbook/edg_src/EDG_chapter_env_intro.xml index 2d4fad8645..b812ef2e37 100644 --- a/docbook/edg_src/EDG_chapter_env_intro.xml +++ b/docbook/edg_src/EDG_chapter_env_intro.xml @@ -81,12 +81,12 @@ <section><title>Microsoft Windows</title> <para> - Thanks to the Win32 API, development on all windows platforms will be + Thanks to the Win32 API, development on all Windows platforms will be done in a very similar way. However some differences between the platforms are existing (especially between the NT and 95 based platforms), the - differences will be notified where appropriate. All Windows platforms will - be referred as Win32, Win or Windows might be used with the same meaning. - As Windows CE differs a lot compared to the other windows platforms + differences will be notified where appropriate. All Windows platforms + referred to as Win32, Win or Windows may be used with the same meaning. + As Windows CE differs a lot compared to the other Windows platforms mentioned, Ethereal will not run on Windows CE and there are no plans to support it. <itemizedlist> @@ -235,18 +235,28 @@ <itemizedlist> <listitem> <para> - Win32 (.exe file). The typical windows end user is used to get an setup - .exe file, which will install all the required things for him. + Win32 (.exe file). The typical Windows end user is used to get a setup.exe + file, which will install all the required things for him. </para> </listitem> <listitem> <para> - Debian (.deb file) + Debian (.deb file). A user of a Debian Package Manager (DPKG) based system + is used to get a .deb file from which the package manager checks the + dependancies and installs the software. </para> </listitem> <listitem> <para> - RedHat (.rpm file) + RedHat (.rpm file). A user of a RedHat Package Manager (RPM) based system + is used to get a .rpm file from which the package manager checks the + dependancies and installs the software. + </para> + </listitem> + <listitem> + <para> + Solaris. A Solaris user is used to get a file from which the package manager + (PKG) checks the dependancies and installs the software. </para> </listitem> </itemizedlist> @@ -264,9 +274,9 @@ <section id="ChIntroReleaseSource"> <title>Source code distributions</title> <para> - It's still common for unix developers to give the end user a source + It's still common for UNIX developers to give the end user a source tarball and let the user compile it on their target machine (configure, - make, make install). However, for different unix (linux) distributions + make, make install). However, for different UNIX (Linux) distributions it's becoming more common to release binary packages (e.g. .deb or .rpm files) these days. </para> @@ -292,6 +302,29 @@ places that may be of interest to you (well, beside this guide of course). </para> + + <section id="ChIntroHomepage"><title>Website</title> + <para> + You will find lot's of useful information on the Ethereal homepage at + <ulink url="&EtherealWebSite;">&EtherealWebSite;</ulink>. + </para> + </section> + + <section id="ChIntroWiki"><title>Wiki</title> + <para> + The Ethereal Wiki at <ulink + url="&EtherealWikiSite;">&EtherealWikiSite;</ulink> provides a wide range + of information related to Ethereal and packet capturing in general. + You will find a lot of information not part of this developer's guide. For + example, there is an explanation how to capture on a switched network, + an ongoing effort to build a protocol reference and a lot more. + </para> + <para> + And best of all, if you would like to contribute your knowledge on a + specific topic (maybe a network protocol you know well), you can edit the + wiki pages by simply using your webbrowser. + </para> + </section> <section id="ChIntroFAQ"><title>FAQ</title> <para> @@ -346,6 +379,17 @@ </para> </listitem> </varlistentry> + <varlistentry><term><command>ethereal-bugs</command></term> + <listitem> + <para> + This list is for Ethereal developers. Everytime a change to the bug + database occurs, a mail to this mailing list is generated. + If you want to be notified about all the changes to the bug + database, join this list. Details about the bug database can be + found in <xref linkend="ChIntroBugDatabase"/>. + </para> + </listitem> + </varlistentry> <varlistentry><term><command>ethereal-cvs</command></term> <listitem> <para> @@ -372,7 +416,16 @@ </tip> </para> </section> - + + <section id="ChIntroBugDatabase"><title>Bug database</title> + <para> + The Etereal community started collecting bug reports in a Bugzilla database at + <ulink url="&EtherealBugsSite;">&EtherealBugsSite;</ulink>. + This database is filled with manually filed bug reports, usually after some + discussion on ethereal-dev, and bug reports from the QA build tooling. + </para> + </section> + <section id="ChIntroReportProblems"><title>Reporting Problems</title> <note><title>Note!</title> <para> @@ -430,8 +483,9 @@ </note> <note><title>Don't send confidential information!</title> <para> - If you send captured data to the mailing lists, be sure they don't contain - any sensitive or confidential information like passwords or such. + If you send captured data to the mailing lists, or add it to your bug report, + be sure it doesn't contain any sensitive or confidential information, + such as passwords. </para> </note> </section> @@ -480,7 +534,7 @@ $ <para> You should mail the traceback to the <ulink url="mailto:&EtherealDevMailList;">&EtherealDevMailList;</ulink> - mailing list. + mailing list, or append it to your bug report. </para> </section> diff --git a/docbook/edg_src/EDG_preface.xml b/docbook/edg_src/EDG_preface.xml index fcb5fcd830..26212a3e19 100644 --- a/docbook/edg_src/EDG_preface.xml +++ b/docbook/edg_src/EDG_preface.xml @@ -11,9 +11,9 @@ <para> Developers who are new to Ethereal are often having a hard time getting their development environment up and running. This is - especially true for win32 developers, as a lot of the tools and methods - used when building Ethereal are much more common in the unix world than - on win32. + especially true for Win32 developers, as a lot of the tools and methods + used when building Ethereal are much more common in the UNIX world than + on Win32. </para> <para> The first part of this book will describe how to set up the environment @@ -116,8 +116,8 @@ The latest copy of this documentation can always be found at: <!-- <ulink url="&LatestVersionWebsite;">&LatestVersionWebsite;</ulink>; and at: --> - <ulink url="&EtherealWebSite;/docs/developer-guide/"/>. - XXX - is that true? + <ulink url="&EtherealWikiSite;/Development"/> in PDF (A4 and US letter) + and HTML (single and chunked) and CHM format. </para> <!-- <para> In addition, you can find a PDF version of the guide at: @@ -135,7 +135,7 @@ <section id="PreFeedback"> <title>Providing feedback about this document</title> <para> - Should you have any feedback about this document, please send them + Should you have any feedback about this document, please send it to the authors through <ulink url="mailto:&EtherealDevMailList;">&EtherealDevMailList;</ulink>. </para> </section> |