aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Mathieson <martin.mathieson@keysight.com>2020-09-05 21:14:59 +0100
committerMartin Mathieson <martin.r.mathieson@googlemail.com>2020-09-06 12:11:09 +0000
commit43a85d674e68a1024ee6afc93d59d805d3e37108 (patch)
treedec2403a50cc784f69cc26d361722cfca64ca91c
parent9fb13aaa9a97433de83e5c4882d2a718e380ca56 (diff)
Fix more spelling errors in the docbook folder.
There are some lines that show as changed in 'git gui', will see how they look in gitlab..
-rw-r--r--docbook/common_src/typographic_conventions.adoc2
-rw-r--r--docbook/wsdg_src/WSDG_chapter_asn2wrs.adoc36
-rw-r--r--docbook/wsdg_src/WSDG_chapter_quick_setup.adoc2
-rw-r--r--docbook/wsdg_src/WSDG_chapter_sources.adoc2
-rw-r--r--docbook/wsug_src/WSUG_app_files.adoc4
-rw-r--r--docbook/wsug_src/WSUG_chapter_advanced.adoc8
-rw-r--r--docbook/wsug_src/WSUG_chapter_capture.adoc2
-rw-r--r--docbook/wsug_src/WSUG_chapter_customize.adoc4
-rw-r--r--docbook/wsug_src/WSUG_chapter_io.adoc2
-rw-r--r--docbook/wsug_src/WSUG_chapter_mate.adoc22
-rw-r--r--docbook/wsug_src/WSUG_chapter_statistics.adoc2
11 files changed, 43 insertions, 43 deletions
diff --git a/docbook/common_src/typographic_conventions.adoc b/docbook/common_src/typographic_conventions.adoc
index 9ebc53a6c8..596718cad4 100644
--- a/docbook/common_src/typographic_conventions.adoc
+++ b/docbook/common_src/typographic_conventions.adoc
@@ -6,7 +6,7 @@ The following table shows the typographic conventions that are used in this guid
// https://github.com/oreillymedia/orm_book_samples/blob/master/asciidoc_only/preface.adoc
-// AsciiDoc allows alternative markup for some styles, specifially
+// AsciiDoc allows alternative markup for some styles, specifically
// 'single quotes' and _underlines_ for italics and +plus signs+ and
// `backticks` for monospaces.
// Asciidoctor’s modern mode is more strict, and only allows _underline_
diff --git a/docbook/wsdg_src/WSDG_chapter_asn2wrs.adoc b/docbook/wsdg_src/WSDG_chapter_asn2wrs.adoc
index 1847ea3032..7391018de0 100644
--- a/docbook/wsdg_src/WSDG_chapter_asn2wrs.adoc
+++ b/docbook/wsdg_src/WSDG_chapter_asn2wrs.adoc
@@ -71,17 +71,17 @@ If you still think you'd like to build your module as a plugin, see https://wiki
When running asn2wrs, you could get the following errors:
-* A LexToken error (`__main__.ParseError: LexToken(DOT,'.',71)`)
+* A LexToken error (`__main__.ParseError: LexToken(DOT,'.',71)`)
means that something is not understood in the ASN1 file, line 71,
around the dot (.) - can be the dot itself.
-* A ParseError (`__main__.ParseError: LexToken(SEMICOLON,';',88)`) means that the ';' (SEMICOLON) is not understood. Maybe removing it will work?
+* A ParseError (`__main__.ParseError: LexToken(SEMICOLON,';',88)`) means that the ';' (SEMICOLON) is not understood. Maybe removing it will work?
[[HandMassagingTheASN1File]]
=== Hand-Massaging The ASN.1 File
If a portion of your ASN.1 file is unsupported you can modify it by hand as needed.
-However, the preferred way to resolve the issue is to report it on the link:{wireshark-mailing-lists-url}wireshark-dev[wireshark-dev] mailng list or in the issue tracker so that asn2wrs can be improved.
+However, the preferred way to resolve the issue is to report it on the link:{wireshark-mailing-lists-url}wireshark-dev[wireshark-dev] mailing list or in the issue tracker so that asn2wrs can be improved.
[[CommandLineSyntax]]
=== Command Line Syntax
@@ -336,7 +336,7 @@ offset = dissect_ber_integer(TRUE, pinfo, tree, tvb, offset, hf_index, NULL);
This tells Asn2wrs to not
autogenerate any code at all for the Degree-Of-Overlap object instead it
should use the code specified here. Note that we
-do have to specify the implicit_tag value explicitely and we can NOT use
+do have to specify the implicit_tag value explicitly and we can NOT use
the parameter passed to the function from the caller (also due to the
bug in Asn2wrs) this is the TRUE parameter in the call to
dissect_ber_integer(). We specify TRUE here since
@@ -394,7 +394,7 @@ MessageTransferEnvelope ::= SET {
}
----
-This isn't an entirely correct ASN.1 defintion, but should allow
+This isn't an entirely correct ASN.1 definition, but should allow
successful parsing.
[[ImportedModuleNameConflicts]]
@@ -444,7 +444,7 @@ The following snippets show the different files that make up a dissector for a
FOO protocol dissector
----------------------
-This trivial dissector is an example for the strugling dissector developer (me included)
+This trivial dissector is an example for the struggling dissector developer (me included)
of how to create a dissector for a protocol that is encapsulated in UDP packets
for a specific port, and the packet data is ASN1 PER encoded.
@@ -1006,7 +1006,7 @@ directive.
This particular example also requires us to keep some state between the
two field dissectors, namely the OBJECT IDENTIFIER from algorithm which
-specifis what the content of parameters is. For
+specifies what the content of parameters is. For
this one we need a string where we store the oid from
AlgorithmIdentifier/algorithm so that we can pick it up and act on
later from inside the dissector for AlgorithmIdentifier/parameters.
@@ -1029,7 +1029,7 @@ up. Then we add to the conformance file:
----
The dissector body we specified for AlgorithmIdentifier/algorithmId
-here stores the retreived OID inside the variable algorithm_id we
+here stores the retrieved OID inside the variable algorithm_id we
specified. +
When we later come to the dissector for
AlgorithmIdentifier/parameters we pick this OID up from the static
@@ -1064,7 +1064,7 @@ Which tells the Asn2wrs compiler that the types 'Name',
declared inside the external InformationFramework ASN module and
that they are referenced from this module.
In order for Asn2wrs to generate correct code for the
-dissection it is neccesary to give it some help by telling what kind of
+dissection it is necessary to give it some help by telling what kind of
types these are, i.e. are they INTEGERs or SEQUENCEs or something
else.
@@ -1129,9 +1129,9 @@ dissector for that function and also any value_strings while
I.e. #.USER_DEFINED will emit declarations such
as
-`extern const value_string Type_vals[];`
+`extern const value_string Type_vals[];`
and
-`[static] int dissect_Proto_Type(...);`
+`[static] int dissect_Proto_Type(...);`
Use #.NO_EMIT if you dont need to call this function at all from anywhere (except from the template itself) and use #.USER_DEFINED is better if you implement the function inside the template but still want to allow it to be called from other places.
// (need much better explanation here)
@@ -1175,7 +1175,7 @@ The wrapper functions that are created will all be named and have the
following signature:
----
-static void dissect_ProtocolName_ObjectName(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
+static void dissect_ProtocolName_ObjectName(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
----
Notice that this is exactly the same signature as `dissector_t` which is used by all dissector entry points.
@@ -1199,8 +1199,8 @@ This will result in Asn2wrs creating this wrapper function in the packet-foo.c d
[source,c]
----
-static void dissect_SomeObject_PDU(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree) {
- dissect_foo_SomeObject(FALSE, ...
+static void dissect_SomeObject_PDU(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree) {
+ dissect_foo_SomeObject(FALSE, ...
}
----
@@ -1216,9 +1216,9 @@ In particular, some of the structures here encode an OID in a field and then the
One such example can be seen in the ASN.1 description for X.509/AuthenticationFramework which has a structure defined such as
----
-AlgorithmIdentifier ::= SEQUENCE {
- algorithm   ALGORITHM.&id({SupportedAlgorithms}),
- parameters  ALGORITHM.&Type({SupportedAlgorithms}{@algorithm}) OPTIONAL
+AlgorithmIdentifier ::= SEQUENCE {
+ algorithm ALGORITHM.&id({SupportedAlgorithms}),
+ parameters ALGORITHM.&Type({SupportedAlgorithms}{@algorithm}) OPTIONAL
}
----
@@ -1250,7 +1250,7 @@ The "id-at-userCertificate" is just a free form text string to make Wireshark pr
During the compilation phase Asn2wrs will put all the extra registration code for this in the include file
packet-protocol-dis-tab.c.
-Make sure that you include this file from the template file or the registration to an OID will never occur. `#include "packet-protocol-dis-tab.c"` should be included from the proto_reg_handoff_protocol function in the template file.
+Make sure that you include this file from the template file or the registration to an OID will never occur. `#include "packet-protocol-dis-tab.c"` should be included from the proto_reg_handoff_protocol function in the template file.
[[ASN1CnfDirectiveREGISTERSeeAlso]]
===== See Also
diff --git a/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc b/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc
index 82774bff1a..2de9c40bb3 100644
--- a/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc
+++ b/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc
@@ -230,7 +230,7 @@ Chocolatey ensures cmake.exe is on your path.
https://asciidoctor.org/[Asciidoctor] can be run directly as a Ruby
script or via a Java wrapper (AsciidoctorJ). It is used in conjunction
-with Xsltproc and DocBook to generate the documenation you're reading
+with Xsltproc and DocBook to generate the documentation you're reading
and the User’s Guide.
The easiest way to install them on Windows is via Chocolatey:
diff --git a/docbook/wsdg_src/WSDG_chapter_sources.adoc b/docbook/wsdg_src/WSDG_chapter_sources.adoc
index 8f62c3728f..5293044fca 100644
--- a/docbook/wsdg_src/WSDG_chapter_sources.adoc
+++ b/docbook/wsdg_src/WSDG_chapter_sources.adoc
@@ -278,7 +278,7 @@ See the {wireshark-man-page-url}wireshark.html#ENVIRONMENT-VARIABLES[ENVIRONMENT
==== Windows Native
By default the CMake-generated Visual {cpp} project places all of the files necessary to run Wireshark in the subdirectory `run\RelWithDebInfo`.
-As with the Unix-like build desribed above, you can run Wireshark from the build directory without installing it first.
+As with the Unix-like build described above, you can run Wireshark from the build directory without installing it first.
[source,cmd]
----
diff --git a/docbook/wsug_src/WSUG_app_files.adoc b/docbook/wsug_src/WSUG_app_files.adoc
index 903efad9ad..d298b57d12 100644
--- a/docbook/wsug_src/WSUG_app_files.adoc
+++ b/docbook/wsug_src/WSUG_app_files.adoc
@@ -384,7 +384,7 @@ manuf::
At program start, if there is a _manuf_ file in the global configuration folder, it is read.
The entries in this file are used to translate MAC address prefixes into short and long manufacturer names.
-Each line consists of a MAC address prefix followed by an abbreviated manufaturer name and the full manufacturer name.
+Each line consists of a MAC address prefix followed by an abbreviated manufacturer name and the full manufacturer name.
Prefixes 24 bits long by default and may be followed by an optional length.
Note that this is not the same format as the _ethers_ file.
@@ -436,7 +436,7 @@ It is also written and read whenever you switch to a different profile.
recent_common::
+
--
-This file contains common GUI settings, such as recently openened capture files, recently used filters, and window geometries.
+This file contains common GUI settings, such as recently opened capture files, recently used filters, and window geometries.
It is a simple text file containing statements of the form:
----
diff --git a/docbook/wsug_src/WSUG_chapter_advanced.adoc b/docbook/wsug_src/WSUG_chapter_advanced.adoc
index ccf8a2dbce..561d7c2941 100644
--- a/docbook/wsug_src/WSUG_chapter_advanced.adoc
+++ b/docbook/wsug_src/WSUG_chapter_advanced.adoc
@@ -47,7 +47,7 @@ network. Non-printable characters are replaced by dots.
Traffic from the client to the server is colored red, while traffic
from the server to the client is
colored blue. These colors can be changed by opening menu:Edit[Preferences] and
-under menu:Apperance[Font and Colors], selecting different colors for the
+under menu:Appearance[Font and Colors], selecting different colors for the
btn:[Sample "Follow Stream" client text] and btn:[Sample "Follow Stream" server text]
options.
@@ -202,7 +202,7 @@ The goal is to give you a better idea of uncommon or notable network behaviour a
====
Expert information is the starting point for investigation, not the stopping point.
Every network is different, and it's up to you to verify that Wireshark’s expert information applies to your particular situation.
-The presence of expert informantion doesn't necessarily indicate a problem and absence of expert information doesn’t necessarily mean everything is OK.
+The presence of expert information doesn't necessarily indicate a problem and absence of expert information doesn’t necessarily mean everything is OK.
====
The amount of expert information largely depends on the protocol being used.
@@ -513,7 +513,7 @@ Supersedes “Spurious Retransmission” and “Retransmission”.
[discrete]
==== TCP Port numbers reused
-Set when the SYN flag is set (not SYN+ACK), we have an existing conversation using the same addresses and ports, and the sequencue number is different than the existing conversation’s initial sequence number.
+Set when the SYN flag is set (not SYN+ACK), we have an existing conversation using the same addresses and ports, and the sequence number is different than the existing conversation’s initial sequence number.
// TCP_A_LOST_PACKET
[discrete]
@@ -988,7 +988,7 @@ you hours of work. Unfortunately, it also has its drawbacks.
* _Resolved names might not be available._
Wireshark obtains name resolution information from a variety of sources, including DNS servers, the capture file itself (e.g. for a pcapng file), and the _hosts_ files on your system and in your <<ChAppFilesConfigurationSection,profile directory>>.
-The resolved names might not be available if you open the capture file later or on a different machine. As a result, each time you or someone else opens a particularl capture file it may look slightly different due to changing environments.
+The resolved names might not be available if you open the capture file later or on a different machine. As a result, each time you or someone else opens a particular capture file it may look slightly different due to changing environments.
* _DNS may add additional packets to your capture file._
You might run into the link:{wikipedia-main-url}Observer_effect_(information_technology)[observer effect] if the extra traffic from Wireshark’s DNS queries and responses affects the problem you're trying to troubleshoot or any subsequent analysis.
diff --git a/docbook/wsug_src/WSUG_chapter_capture.adoc b/docbook/wsug_src/WSUG_chapter_capture.adoc
index 328f3a4aa9..db5707942b 100644
--- a/docbook/wsug_src/WSUG_chapter_capture.adoc
+++ b/docbook/wsug_src/WSUG_chapter_capture.adoc
@@ -328,7 +328,7 @@ Once installation is completed go to the Services control panel, find the Remote
On Linux or Unix you can capture (and do so more securely) through an SSH tunnel.
-To add a new remore capture interface, click btn:[{plus}] and specify the following:
+To add a new remote capture interface, click btn:[{plus}] and specify the following:
Host::
The IP address or host name of the target platform where the Remote Packet Capture Protocol service is listening.
diff --git a/docbook/wsug_src/WSUG_chapter_customize.adoc b/docbook/wsug_src/WSUG_chapter_customize.adoc
index e40d1f68a7..b900fc9d0f 100644
--- a/docbook/wsug_src/WSUG_chapter_customize.adoc
+++ b/docbook/wsug_src/WSUG_chapter_customize.adoc
@@ -258,7 +258,7 @@ argument is a string that may contain the following letters:
Enable network address resolution.
t::
- Enable transport layer port number resoultion.
+ Enable transport layer port number resolution.
v::
Enable VLAN ID resolution.
@@ -1149,7 +1149,7 @@ If this option is enabled, Wireshark will load all *.proto files in this directo
and its subdirectories when Wireshark startup or protobuf search paths preferences
changed. Note that the source directories that configured to protobuf offical or third
libraries path (like `d:/protobuf-3.4.1/include/`) should not be set to load all
-files, that may cause memory unnecessary occuption.
+files, that may cause unnecessary memory use.
[[ChProtobufUDPMessageTypes]]
diff --git a/docbook/wsug_src/WSUG_chapter_io.adoc b/docbook/wsug_src/WSUG_chapter_io.adoc
index ce7ac01fdc..c1b5d2fd8f 100644
--- a/docbook/wsug_src/WSUG_chapter_io.adoc
+++ b/docbook/wsug_src/WSUG_chapter_io.adoc
@@ -594,7 +594,7 @@ This lets you save the packet list, packet details, and packet bytes as plain te
.The “Export Packet Dissections” dialog box
image::wsug_graphics/ws-export-packet-dissections.png[{medium-screenshot-attrs}]
-The format can be selected from the “Export As” dopdown and further customized using the “<<ChIOPacketRangeSection,Packet Range>>” and “<<ChIOPacketRangeSection,Packet Format>>” controls.
+The format can be selected from the “Export As” dropdown and further customized using the “<<ChIOPacketRangeSection,Packet Range>>” and “<<ChIOPacketRangeSection,Packet Format>>” controls.
Some controls are unavailable for some formats, notably CSV and JSON.
The following formats are supported:
diff --git a/docbook/wsug_src/WSUG_chapter_mate.adoc b/docbook/wsug_src/WSUG_chapter_mate.adoc
index 015c734a10..745b7c06c3 100644
--- a/docbook/wsug_src/WSUG_chapter_mate.adoc
+++ b/docbook/wsug_src/WSUG_chapter_mate.adoc
@@ -184,7 +184,7 @@ data AVP's value string
lower than the string given
* <<HigherThan,Higher Than>> _>_ will match if the data AVP's value string is semantically
higher than the string given
-* <<Exists,Exists>> _?_ (the ? can be ommited) will match as far as a data AVP of the
+* <<Exists,Exists>> _?_ (the ? can be omitted) will match as far as a data AVP of the
given name exists
==== AVP lists
@@ -241,7 +241,7 @@ whose _Proto_ is contained in the frame.
to group it to other Pdus into a Gop (Group of Pdus) by matching the key
criteria given by a _Gop_ declaration. If there is no Gop yet with the key
criteria for the Pdu, MATE will try to create a new Gop for it if it matches the
-_Start_ criterium given in the Gop declaration.
+_Start_ criteria given in the Gop declaration.
* In the third phase, if there's a Gop for the Pdu, MATE will try to group this
Gop with other Gops into a Gog (Group of Groups) using the criteria given by the
@@ -536,7 +536,7 @@ examples.
mate dns_pdu:6->dns_req:1
dns_pdu: 6
dns_pdu time: 2.103063
- dns_pdu time since begining of Gop: 2.103063
+ dns_pdu time since beginning of Gop: 2.103063
dns_req: 1
dns_req Attributes
dns_id: 36012
@@ -580,7 +580,7 @@ Note that there are two "timers" for a Gop:
* *Time*, which is defined only for Gops that have been Stopped, and gives the
time passed between the _Start_ and the _Stop_ Pdus.
-* *Duration*, which is defined for every Gop regardles of its state, and give
+* *Duration*, which is defined for every Gop regardless of its state, and give
the time passed between its _Start_ Pdu and the last Pdu that was assigned to
that Gop.
@@ -651,7 +651,7 @@ Gog web_use {
mate http_pdu:4->http_req:2->http_use:1
http_pdu: 4
http_pdu time: 1.309847
- http_pdu time since begining of Gop: 0.218930
+ http_pdu time since beginning of Gop: 0.218930
http_req: 2
... (the gop's tree for http_req: 2) ..
http_use: 1
@@ -671,7 +671,7 @@ mate http_pdu:4->http_req:2->http_use:1
We can filter on:
* *mate.http_use.Duration* time elapsed between the first frame of a Gog and the last one assigned to it.
-* the attributess passed to the Gog
+* the attributes passed to the Gog
** *mate.http_use.host*
===== AVPL Transforms
@@ -891,7 +891,7 @@ Pdu my_pdu Proto my_proto transport tcp/ip/eth {
==== About MATE
-MATE was originally written by Luis Ontanon, a Telecomunications systems
+MATE was originally written by Luis Ontanon, a Telecommunications systems
troubleshooter, as a way to save time filtering out the packets of a single call
from huge capture files using just the calling number. Later he used the time he
had saved to make it flexible enough to work with protocols other than the ones
@@ -1273,7 +1273,7 @@ Gop user_smtp_ses On user_smtp (user_ip, user_ip, smtp_port!25) {
Stop (tcp_stop=1);
}
-// with the following group of groups we'll group toghether the radius and the smtp
+// with the following group of groups we'll group together the radius and the smtp
// we set a long expiration to avoid the session expire on long pauses.
Gog user_mail {
Expiration 1800;
@@ -1306,7 +1306,7 @@ Pdu q931 Proto q931 Transport ip {
Gop q931_leg On q931 Match (addr, addr, call_ref) {
Start (q931_msg=5);
Stop (q931_msg=90);
- Extra (calling, called, guid, q931_cuase);
+ Extra (calling, called, guid, q931_cause);
};
Pdu ras Proto h225.RasMessage Transport ip {
@@ -1954,7 +1954,7 @@ Other than the Pdu's _Proto_ and its _Transport_ protocols, there is also a
_Payload_ attribute to tell MATE from which ranges of _Proto_'s payload to
extract fields of a frame into the Pdu. In order to extract an attribute from a
frame's tree the highlighted area of the field in the hex display must be within
-the area of the _Proto_'s relative payload(s). _Payload_ s are choosen moving
+the area of the _Proto_'s relative payload(s). _Payload_ s are chosen moving
forward from the protocol area, in the order they are given.
_Proto http Transport tcp/ip Payload mmse_ will select the first mmse range
after the current http range. Once we've selected the _Payload_ ranges, MATE
@@ -2303,7 +2303,7 @@ Action=Include; {Filename=filename;|Lib=libname;}
====== Filename
-The filename of the file to include. If it does not beging with '/' it will look
+The filename of the file to include. If it does not begin with '/' it will look
for the file in the current path.
====== Lib
diff --git a/docbook/wsug_src/WSUG_chapter_statistics.adoc b/docbook/wsug_src/WSUG_chapter_statistics.adoc
index 7b061bb74a..653d8459f8 100644
--- a/docbook/wsug_src/WSUG_chapter_statistics.adoc
+++ b/docbook/wsug_src/WSUG_chapter_statistics.adoc
@@ -255,7 +255,7 @@ JXTA:: A 160 bit SHA-1 URN.
NCP:: Similar to IPX.
-RSVP:: A combination of varios RSVP session attributes and IPv4 addresses.
+RSVP:: A combination of various RSVP session attributes and IPv4 addresses.
SCTP:: A combination of the host IP addresses (plural) and
the SCTP port used. So different SCTP ports on the same IP address are different