doc: typos

Signed-off-by: Alessandro Rubini <rubini@gnudd.com>

doc: typos
Signed-off-by: Alessandro Rubini <rubini@gnudd.com>
c189e26c · Alessandro Rubini · 108f05e6 · c189e26c · c189e26c · c189e26c
Commit c189e26c authored Jul 16, 2015 by Alessandro Rubini
Hide whitespace changes
Inline Side-by-side

Showing with 34 additions and 29 deletions

flash-wrs build/flash-wrs +1 -1

wrs-developer-manual.in doc/wrs-developer-manual.in +16 -14

wrs-user-manual.in doc/wrs-user-manual.in +17 -14

No files found.
--- a/build/flash-wrs
+++ b/build/flash-wrs
@@ -243,7 +243,7 @@ if lsusb | grep -q "at91sam" || $fake; then
 else
 	echo ""
 	echo "$me: Waiting for at91sam SAMBA bootloader on usb."
-	echo "    Please check the Managment USB cable is connected "
+	echo "    Please check the Management USB cable is connected "
 	echo "    and keep pressed the Flash button while" 
 	echo "    resetting/powering the switch."
 	while true; do

--- a/doc/wrs-developer-manual.in
+++ b/doc/wrs-developer-manual.in
@@ -45,7 +45,7 @@
 @title White Rabbit Switch: Developer's Manual
 @subtitle Information about software in the White Rabbit switch, for developers and advanced users
 @subtitle @value{update-month} (@value{release})
-@author Alessandro Rubini, Benoit Rat, Federico Vaga et al.
+@author Alessandro Rubini, Adam Wujek, Benoit Rat, Federico Vaga, ...
 @end titlepage
 @headings single
@@ -328,7 +328,7 @@ place.
 Every downloaded file is saved to the @code{downloads} directory 
 (@code{$WRS_DOWNLOAD_DIR} if set, or the default place
-@code{$WRS_OUPUT_DIR/downloads}). You should
+@code{$WRS_OUTPUT_DIR/downloads}). You should
 arrange not to remove that directory when you recompile over and over
 during development. I chose to make the first
 script download everything, before starting any build, to help
@@ -1067,7 +1067,7 @@ devices you can avoid this ``@code{-e}'' argument.
 @c FIXME: -e for dataflash
-@b{Note:} White Rabbit switches are shipped with their preallocated
+@b{Note:} White Rabbit switches are shipped with their pre-allocated
 MAC addresses, reported in a sticker on the back side of the switch;
 if re-flashing, you may want to use the same values.
@@ -1092,7 +1092,7 @@ and 02:34:56:78:9A:00 for MAC2 (the base address for the 18 SFP ports).
   Warning: you did not set the MAC2 value; using "02:34:56:78:9A:00"
   flash-wrs: Waiting for at91sam SAMBA bootloader on usb.
-       Please check the Managment USB cable is connected
+       Please check the Management USB cable is connected
       and keep pressed the Flash button while
       resetting/powering the switch.
   ............. Ok
@@ -1225,7 +1225,7 @@ You might also want to check its embedded documentations using:
 $ ./build/flash-wrs --help
 Usage: ./build/flash-wrs [options] [<firmware>.tar.gz] [DEV]
-MAC:	 MAC address in hexadecimal seperated by ':' (i.e, AB:CD:EF:01:23:45)
+MAC:	 MAC address in hexadecimal separated by ':' (i.e, AB:CD:EF:01:23:45)
 <firmware>.tar.gz: Use the file in the firmware to flash the device
 DEV:	 The usb device (by default it is /dev/ttyACM0)
 Options: 
@@ -1366,7 +1366,7 @@ developers are ever expected to change the hardware information data.
 Overall, the following is the content of @file{/proc/mtd}
 after boot.  It is divided in stanzas for a better reading:
 NAND partitioning, dataflash partitioning and the UBI volumes
-stored withing ``UBIfied-NAND'' are thus shown in selarate blocks:
+stored withing ``UBIfied-NAND'' are thus shown in separate blocks:
 @example
   dev:    size   erasesize  name
@@ -1413,7 +1413,7 @@ boot scripts):
 @item update
 	The volume is a storage place for firmware upgrade. If you
-        copy @t{wrs-firwware.tar} in this volume, the next boot will
+        copy @t{wrs-firmware.tar} in this volume, the next boot will
        completely replace @t{/usr} with this new image. If the tar
        file includes them, the kernel and @i{initramfs} image are
        replaced as well.  Developers can copy individual files,
@@ -1648,7 +1648,7 @@ for details about how they are used:
        before writing its own @t{pid}, and a reader will wait for the @t{pid}
        to be valid (i.e. it waits for a writer to be there). A writer using
        the ``locked'' flag must release the lock after initialization
-        by calling @t{wrs_shme_write(WRS_SHM_WRITE_END)}.
+        by calling @t{wrs_shmem_write(WRS_SHM_WRITE_END)}.
        On error NULL is returned, and errno is set to @t{EINVAL},
        @t{ETIMEDOUT} or to the error returned by underlying system calls
        (for example, @t{EPERM} if the file cannot be mapped).
@@ -1738,7 +1738,7 @@ of boots since power on. It does so relying on 4 32-bit @sc{cpu}
 registers that are unpredictable at power-up and remain unchanged over
 reboots. They are called ``backup registers'' in vendor documentation
 (@t{GPBR}): they actually read 0 on power-up but the documentation
-doesn`t say anything so we can't count on it.
+doesn't say anything so we can't count on it.
 Our kernel patches use the 16 bytes in the following way; all values
 are little-endian.
@@ -1766,7 +1766,7 @@ are little-endian.
 	The number of soft reboots. This is incremented by the
 	@i{reboot} system call, and not by accidental reboots
 	(i.e. panic or other yet-unforeseen situation).  A healthy
-	sytem should feature one soft-reboot less than total boots.
+	system should feature one soft-reboot less than total boots.
 @item bytes 8..11
@@ -1989,7 +1989,7 @@ console, on the backplane.
 @node From the Linux Shell
 @subsection From the Linux Shell
-The information lives in partion @t{mtd5}, as shown in @t{/proc/mtd}
+The information lives in partition @t{mtd5}, as shown in @t{/proc/mtd}
 (Memory Technology Device). To avoid accidental erasure, our
 filesystem doesn't include the device file @t{/dev/mtd5}, but only
 the read-only counterpart, @t{/dev/mtd5ro}.
@@ -2020,7 +2020,7 @@ If you prefer creating or replacing @i{hwinfo} from the boot loader,
 this is the procedure. You can't run it with software version 4.0 or
 earlier, because our boot loader was unable to access
 @i{dataflash}. V4.1 fixed this problem and introduced the @t{sdb}
-command in the booloader to access your @i{hwinfo} structure.
+command in the bootloader to access your @i{hwinfo} structure.
 @smallexample
   erase /dev/dataflash0.hwinfo
@@ -2146,7 +2146,7 @@ details are different.
 Even if the package is already released and used in production,
 some details can be
-suboptimal, while some procedures may be tricky and need more explanation.
+sub-optimal, while some procedures may be tricky and need more explanation.
 We are collecting all those issues in the @i{wiki} page of the
 project, to avoid frequent updates to this manual to just collect
@@ -2167,4 +2167,6 @@ on the mailing list if you don't find help there.
 @c  LocalWords:  filesystem diff ohwr http mkdir linux rubini itemize PTPd VHDL
 @c  LocalWords:  noposix ptpd userspace libwr DataFlash NAND barebox FPGA
 @c  LocalWords:  Atmel Kconfig minicom tinyserial ttyUSB bootloader logfile
-@c  LocalWords:  nandflash gateware TFTP init wrboot wiki
+@c  LocalWords:  nandflash gateware TFTP init wrboot wiki pathname
+@c  LocalWords:  subdirectory filename configs pathnames multicast
+@c  LocalWords:  DHCP submodule minipc ppsi vlan shmem hwinfo ethaddr
--- a/doc/wrs-user-manual.in
+++ b/doc/wrs-user-manual.in
@@ -45,7 +45,7 @@
 @title White Rabbit Switch: User's Manual
 @subtitle Information about configuring the White Rabbit switch, for final users
 @subtitle @value{update-month} (@value{release})
-@author Alessandro Rubini, Benoit Rat, Federico Vaga et al.
+@author Alessandro Rubini, Adam Wujek, Benoit Rat, Federico Vaga, ...
 @end titlepage
 @headings single
@@ -97,7 +97,7 @@ This is the current set of manuals that accompany the @sc{wrs}:
 @item @i{White Rabbit Switch: Developer's Manual}: it describes the
   build procedure and how internals work; use of scripts and
-   @sc{wrs}-specific executables and so on.  The manual is by developers
+   @sc{wrs}-specific programs and so on.  The manual is by developers
   and for developers.  This is the
   document to check if you need to customize your @i{wrs} rebuild
   software from new repository commits that are not an official release
@@ -168,7 +168,7 @@ includes the MAC addresses for the management Ethernet and the
 time, a bad practice developed in a hurry.
 The @i{hwinfo} structure is now written to @i{dataflash} by the
-manufacturer, and never changed even when perforiming a complete re-flash
+manufacturer, and never changed even when performing a complete re-flash
 of the device, because the flashing scripts preserve the @i{hwinfo}
 memory area.
@@ -181,7 +181,7 @@ need to be aware of the steps involved, in case something goes wrong.
 @section Upgrading from v4.0
 Version 4.0 and later of @t{wr-switch-sw} are able to upgrade
-themselves if you place the profer files in the @i{/update} directory
+themselves if you place the proper files in the @i{/update} directory
 of the @sc{wrs}.  However, in version 4.0 we forgot to provide for
 an upgrade of the boot loader and didn't note that if the front USB
 cable is not plugged, the upgrade procedure blocks.
@@ -209,7 +209,7 @@ actually used:
   @item Copy your own @t{wrs-firmware.tar} for at least v4.1 into the
   @i{/update} partition.
-   This can be the official firwmare or one you built yourself.
+   This can be the official firmware or one you built yourself.
   Then reboot and wait for everything to settle (the system will reboot
   once more by itself).
@@ -238,7 +238,7 @@ filesystem before rebooting.
 @itemize
   @item Copy your own @t{wrs-firmware.tar} for at least v4.1 into the
-   @i{/update} partition. This can be the official firwmare or one you built
+   @i{/update} partition. This can be the official firmware or one you built
   yourself.
   @item Create and mount @i{/boot} within the switch. This means
@@ -283,7 +283,7 @@ manuals) and then proceed as described in @ref{Upgrading from v4.0}.
 When flashing version 4.0 you'll need to pass your MAC addresses on
 the command line of the flasher, so please take not of what they are.
-Another option is flashing the latest firwmare version and then build
+Another option is flashing the latest firmware version and then build
 your own @i{hwinfo} structure by specifying your MAC addresses.
 @t{wr-switch-sw} includes specific tools for both steps. They are
 described in the @i{Developer's Manual}, because they are expected to
@@ -575,7 +575,7 @@ value is changed by the web interface, proper action is taken.
        items should be set (running ``@t{make menuconfig}'' offers
        them as an exclusive choice). The options select a grand-master
        with external reference, from GPS or Cesium or both; a free-running
-        master, used for isolated acquisition networks, withouth an
+        master, used for isolated acquisition networks, without an
        external reference; or a normal ``boundary-clock'' device that
        is slave on some ports and master on other ports.
@@ -684,7 +684,7 @@ and are determined by a calibration procedure.  These values are
 used as constant delays in the @i{tx} and @i{rx} directions.
 @item The port is also configured as slave (@i{role}) using raw whiterabbit
-prootocol (@i{proto}) and is deployed using fiber type 2 -- this number
+protocol (@i{proto}) and is deployed using fiber type 2 -- this number
 is just a local enumeration of fiber types; most likely you'll be
 using type ``0'' in every port.
@@ -713,7 +713,7 @@ First try is to match all SFP identifiers (@i{vn}, @i{pn} and @i{vs}) with
 stored in config. If match is not successful, @i{vn} and @i{pn} of SFP are
 compared only with config entries without vendor serial. If match is still not
 found SFP's values are compared with config entries, which has defined only
-part number. Such approach prevents matching SFPs to config entires with
+part number. Such approach prevents matching SFPs to config entries with
 defined serial.
 Below are shown matching examples:
@@ -736,7 +736,7 @@ that were not matched by configs above.
 @subheading Other Deployments
 The example above matches the choices we make at CERN, where our
-White Rabbit networks are all run with a single monomodal fiber
+White Rabbit networks are all run with a single mono-modal fiber
 and  1310/1490 light.
 If you are using dual-fiber transceivers, which is acceptable for
@@ -829,7 +829,7 @@ like the following:
 If flashing of the whole system was successful, the first entry will
 simply work, booting the switch without any network access.  Although
-a DCHP client runs by default after boot, everything will work even if
+a DHCP client runs by default after boot, everything will work even if
 you leave the Ethernet port unconnected or you have no DHCP server
 when the switch is operational.
@@ -1195,7 +1195,7 @@ configuration is divided into two parts:
  tagged frames not belonging to the configured VLAN
  @item TRUNK - passes only tagged frames, drops all untagged frames
  @item Disabled - VLANs disabled
-  @item Unqualified port - passess all frames regardless of VLAN configuration
+  @item Unqualified port - passes all frames regardless of VLAN configuration
  @end itemize
 @item wrs_vlans --rvid <vid> [options]
@@ -1691,4 +1691,7 @@ on the mailing list if you don't find help there.
 @c  LocalWords:  filesystem diff ohwr http mkdir linux rubini itemize PTPd VHDL
 @c  LocalWords:  noposix ptpd userspace libwr DataFlash NAND barebox FPGA
 @c  LocalWords:  Atmel Kconfig minicom tinyserial ttyUSB bootloader logfile
-@c  LocalWords:  nandflash gateware TFTP init wrboot wiki
+@c  LocalWords:  nandflash gateware TFTP init wrboot wiki LEDs DHCP
+@c  LocalWords:  SNMP hwinfo pathname CONFIG filename Busybox Barebox
+@c  LocalWords:  rsyslog PARAMS subdirectory dhcp nand VLAN vlans
+@c  LocalWords:  auxclk bitstream