aboutsummaryrefslogtreecommitdiffstats
path: root/docbook
diff options
context:
space:
mode:
authorJeff Morriss <jeff.morriss.ws@gmail.com>2013-05-24 14:45:55 +0000
committerJeff Morriss <jeff.morriss.ws@gmail.com>2013-05-24 14:45:55 +0000
commitf93348a2f71de4b2b06d23467de444c89ef8ee09 (patch)
treefdd960a1d2be255b60bce2dd330afd0c14b642ac /docbook
parent3598d9e2ac7582715d0af8a32b5ffccefeec98a9 (diff)
As suggested by Moshe Kaplan in https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=8712 :
When pointing people to the mailing lists, point them directly to the lists page rather than explaining where to look for the link on the main page (the directions were several years out of date). While there also fix up some of the indentation and add a link to the Q&A site in the developer's guide. svn path=/trunk/; revision=49553
Diffstat (limited to 'docbook')
-rw-r--r--docbook/developer-guide.xml10
-rw-r--r--docbook/user-guide.xml9
-rw-r--r--docbook/wsdg_src/WSDG_chapter_env_intro.xml110
-rw-r--r--docbook/wsug_src/WSUG_chapter_introduction.xml67
4 files changed, 114 insertions, 82 deletions
diff --git a/docbook/developer-guide.xml b/docbook/developer-guide.xml
index 0e00913565..f67e3ff113 100644
--- a/docbook/developer-guide.xml
+++ b/docbook/developer-guide.xml
@@ -40,7 +40,13 @@ DOCUMENT SECTION
<!ENTITY % SvnVersionFile SYSTEM "svn_version.xml">
%SvnVersionFile;
-<!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>">
+<!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>">
<!--
Wireshark Info
@@ -56,6 +62,8 @@ Wireshark Info
<!ENTITY WiresharkWikiSite "http://wiki.wireshark.org">
<!ENTITY WiresharkBugsSite "https://bugs.wireshark.org">
<!ENTITY WiresharkRepositorySite "http://anonsvn.wireshark.org">
+ <!ENTITY WiresharkListsPage "&WiresharkWebSite;/lists/">
+ <!ENTITY WiresharkQASite "http://ask.wireshark.org">
<!--
Gnu info
diff --git a/docbook/user-guide.xml b/docbook/user-guide.xml
index a5d4190f81..31e406c15f 100644
--- a/docbook/user-guide.xml
+++ b/docbook/user-guide.xml
@@ -75,7 +75,13 @@ DOCUMENT SECTION
<!ENTITY % SvnVersionFile SYSTEM "svn_version.xml">
%SvnVersionFile;
- <!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>">
+ <!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>">
<!--
Wireshark Info
@@ -97,6 +103,7 @@ Wireshark Info
<!ENTITY WiresharkWikiPreferencesPage "&WiresharkWikiPage;/Preferences">
<!ENTITY WiresharkWikiPcapNgPage "&WiresharkWikiPage;/Development/PcapNg">
<!ENTITY WiresharkQASite "http://ask.wireshark.org">
+ <!ENTITY WiresharkListsPage "&WiresharkWebSite;/lists/">
<!ENTITY WiresharkDevMailList "wireshark-dev[AT]wireshark.org">
<!ENTITY WiresharkUsersMailList "wireshark-users[AT]wireshark.org">
diff --git a/docbook/wsdg_src/WSDG_chapter_env_intro.xml b/docbook/wsdg_src/WSDG_chapter_env_intro.xml
index 803f4a4040..59b8cd1365 100644
--- a/docbook/wsdg_src/WSDG_chapter_env_intro.xml
+++ b/docbook/wsdg_src/WSDG_chapter_env_intro.xml
@@ -477,7 +477,7 @@
<itemizedlist>
<listitem>
<para>
- the file <filename>doc/README.developer</filename> and
+ the file <filename>doc/README.developer</filename> and
all the other README.xxx files in the source code - these are various
documentation files on different topics
</para>
@@ -492,30 +492,30 @@
</listitem>
<listitem>
<para>
- the Wireshark source code
+ the Wireshark source code
</para>
</listitem>
<listitem>
<para>
- tool documentation of the various tools used
+ tool documentation of the various tools used
(e.g. manpages of sed, gcc, ...)
</para>
</listitem>
<listitem>
<para>
- the different mailing lists: see <xref linkend="ChIntroMailingLists"/>
+ the different mailing lists: see <xref linkend="ChIntroMailingLists"/>
</para>
</listitem>
<listitem>
<para>
- ...
+ ...
</para>
</listitem>
</itemizedlist>
</para>
</section>
- <section id="ChIntroMailingLists"><title>Mailing Lists</title>
+ <section id="ChIntroMailingLists"><title>Mailing Lists</title>
<para>
There are several mailing lists available on specific Wireshark topics:
<variablelist>
@@ -523,7 +523,7 @@
<listitem>
<para>
This mailing list will inform you about new program
- releases, which usually appear about every 4-8 weeks.
+ releases, which usually appear about every 4-8 weeks.
</para>
</listitem>
</varlistentry>
@@ -532,7 +532,7 @@
<para>
This list is for users of Wireshark. People post
questions about building and using Wireshark, others (hopefully)
- provide answers.
+ provide answers.
</para>
</listitem>
</varlistentry>
@@ -540,8 +540,8 @@
<listitem>
<para>
This list is for Wireshark developers. People post questions about
- the development of Wireshark, others (hopefully) provide answers.
- If you want to start developing a protocol dissector, join this list.
+ the development of Wireshark, others (hopefully) provide answers.
+ If you want to start developing a protocol dissector, join this list.
</para>
</listitem>
</varlistentry>
@@ -549,10 +549,10 @@
<listitem>
<para>
This list is for Wireshark developers. Every time 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"/>.
+ 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>
@@ -560,52 +560,66 @@
<listitem>
<para>
This list is for Wireshark developers. Every time a change to the SVN
- repository is checked in, a mail to this mailing list is generated.
- If you want to be notified about all the changes to the SVN
- repository, join this list. Details about the SVN repository can be
- found in <xref linkend="ChSrcSVNServer"/>.
+ repository is checked in, a mail to this mailing list is generated.
+ If you want to be notified about all the changes to the SVN
+ repository, join this list. Details about the SVN repository can be
+ found in <xref linkend="ChSrcSVNServer"/>.
</para>
</listitem>
</varlistentry>
</variablelist>
+
You can subscribe to each of these lists from the Wireshark web site:
- <ulink url="&WiresharkWebSite;">&WiresharkWebSite;</ulink>. Simply
- select the <command>mailing lists</command> link on the left hand
- side of the site. The lists are archived at the Wireshark web site
- as well.
- <tip><title>Tip!</title>
- <para>
+ <ulink url="&WiresharkListsPage;">&WiresharkListsPage;</ulink>.
+ From there, you can choose which mailing list you want to subscribe to
+ by clicking on the Subscribe/Unsubscribe/Options button under the title
+ of the relevant list. The links to the archives are included on that
+ page as well.
+
+ <tip><title>Tip!</title>
+ <para>
You can search in the list archives to see if someone previously asked the same
question and maybe already got an answer. That way you
don't have to wait until someone answers your question.
- </para>
- </tip>
+ </para>
+ </tip>
</para>
- </section>
+ </section>
- <section id="ChIntroBugDatabase"><title>Bug database (Bugzilla)</title>
- <para>
- The Wireshark community collects 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 automatic bug reports from the buildbot tools.
- </para>
- </section>
+ <section id="ChIntroBugDatabase"><title>Bug database (Bugzilla)</title>
+ <para>
+ The Wireshark community collects 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 automatic bug reports from the buildbot tools.
+ </para>
+ </section>
- <section id="ChIntroReportProblems"><title>Reporting Problems</title>
- <note><title>Note!</title>
- <para>
- Before reporting any problems, please make sure you have installed the
- latest version of Wireshark. Reports on older maintainance releases are
- usually met with an upgrade request.
- </para>
- </note>
+ <section id="ChIntroQA"><title>Q&amp;A Forum</title>
+ <para>
+ The Wireshark Q and A forum at
+ <ulink url="&WiresharkQASite;">&WiresharkQASite;</ulink> offers a resource
+ where questions and answers come together. You have the option to search
+ what questions were asked before and what answers were given by people who
+ knew about the issue. Answers are graded, so you can pick out the best ones
+ easily. If your issue isn't discussed before you can post one yourself.
+ </para>
+ </section>
+
+ <section id="ChIntroReportProblems"><title>Reporting Problems</title>
+ <note><title>Note!</title>
+ <para>
+ Before reporting any problems, please make sure you have installed the
+ latest version of Wireshark. Reports on older maintainance releases are
+ usually met with an upgrade request.
+ </para>
+ </note>
<para>
- 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 compile/run Wireshark on a lot of different
- platforms.
+ 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 compile/run Wireshark on a lot of different
+ platforms.
</para>
<para>
When reporting problems with Wireshark, it is helpful if you supply the
diff --git a/docbook/wsug_src/WSUG_chapter_introduction.xml b/docbook/wsug_src/WSUG_chapter_introduction.xml
index 850caaea48..f2f08e572d 100644
--- a/docbook/wsug_src/WSUG_chapter_introduction.xml
+++ b/docbook/wsug_src/WSUG_chapter_introduction.xml
@@ -548,42 +548,45 @@
<para>
There are several mailing lists of specific Wireshark topics available:
<variablelist>
- <varlistentry><term><command>wireshark-announce</command></term>
- <listitem>
- <para>
- This mailing list will inform you about new program
- releases, which usually appear about every 4-8 weeks.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term><command>wireshark-users</command></term>
- <listitem>
- <para>
- This list is for users of Wireshark. People post
- questions about building and using Wireshark, others (hopefully)
- provide answers.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry><term><command>wireshark-dev</command></term>
- <listitem>
- <para>
- This list is for Wireshark developers. If you want to start
- developing a protocol dissector, join this list.
- </para>
- </listitem>
- </varlistentry>
+ <varlistentry><term><command>wireshark-announce</command></term>
+ <listitem>
+ <para>
+ This mailing list will inform you about new program
+ releases, which usually appear about every 4-8 weeks.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry><term><command>wireshark-users</command></term>
+ <listitem>
+ <para>
+ This list is for users of Wireshark. People post
+ questions about building and using Wireshark, others (hopefully)
+ provide answers.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry><term><command>wireshark-dev</command></term>
+ <listitem>
+ <para>
+ This list is for Wireshark developers. If you want to start
+ developing a protocol dissector, join this list.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
+
You can subscribe to each of these lists from the Wireshark web site:
- <ulink url="&WiresharkWebSite;">&WiresharkWebSite;</ulink>. Simply
- select the <command>mailing lists</command> link on the left hand
- side of the site. The lists are archived at the Wireshark web site
- as well.
+ <ulink url="&WiresharkListsPage;">&WiresharkListsPage;</ulink>.
+ From there, you can choose which mailing list you want to subscribe to
+ by clicking on the Subscribe/Unsubscribe/Options button under the title
+ of the relevant list. The links to the archives are included on that
+ page as well.
+
<tip><title>Tip!</title>
<para>
- You can search in the list archives to see if someone asked the same
- question some time before and maybe already got an answer. That way you
- don't have to wait until someone answers your question.
+ You can search in the list archives to see if someone asked the same
+ question some time before and maybe already got an answer. That way you
+ don't have to wait until someone answers your question.
</para>
</tip>
</para>