Skip to content

W
White Rabbit Switch - Software
Commit df3df13c authored by Adam Wujek's avatar Adam Wujek 💬
Browse files
Options

doc/wrs-developer-manual: small updates in devel manual 

Signed-off-by: Adam Wujek's avatarAdam Wujek <adam.wujek@cern.ch>
parent c2142235
Hide whitespace changes
Inline Side-by-side
Showing with 11 additions and 4 deletions
doc/wrs-developer-manual.in
View file @ df3df13c
...@@ -105,20 +105,27 @@ This is the current set of manuals that accompany the @sc{wrs}: ...@@ -105,20 +105,27 @@ This is the current set of manuals that accompany the @sc{wrs}:
software from new repository commits that are not an official release software from new repository commits that are not an official release
point, or just install your @i{wrs} with custom configuration values. point, or just install your @i{wrs} with custom configuration values.
@item @i{White Rabbit Switch: Failures and Diagnostics}: describe various
failure scenarios of a switch and ways how to recognize them.
Additionally describe SNMP exports of a switch (WR-SWITCH-MIB).
@end itemize @end itemize
The official @sc{pdf} copy of the three manuals at each release The official @sc{pdf} copy of these manuals at each release
is published in The @i{files} tab of the software project in @t{ohwr.org}: is published in the @i{files} tab of the software project in @t{ohwr.org}:
(@url{http://www.ohwr.org/projects/wr-switch-sw/files}). (@url{http://www.ohwr.org/projects/wr-switch-sw/files}).
This doesn't apply to release 4.0 and earlier. This doesn't apply to release 4.0 and earlier.
The source form of all three manuals is maintained in The source form of first three manuals is maintained in
@t{wr-switch-sw/doc}. Within the repository, both the @i{User's @t{wr-switch-sw/doc}. Within the repository, both the @i{User's
Manual} and the @i{Developer's Manual} are always tracking the Manual} and the @i{Developer's Manual} are always tracking the
software commits, while the @i{Startup Guide} may not be authoritative software commits, while the @i{Startup Guide} may not be authoritative
because it is bound to device shipping rather than software because it is bound to device shipping rather than software
development. development.
The source of fourth document @i{White Rabbit Switch: Failures and Diagnostics} is in
external repository @url{git://ohwr.org/white-rabbit.git} under
@t{docs/specifications/management}.
@c ========================================================================== @c ==========================================================================
@node Supported Hardware Versions @node Supported Hardware Versions
@section Supported Hardware Versions @section Supported Hardware Versions
...@@ -214,7 +221,7 @@ The LM32 program is provided as a pre-compiled binary in ...@@ -214,7 +221,7 @@ The LM32 program is provided as a pre-compiled binary in
If you need to rebuild the @t{rt_cpu.bin} file from source, to make If you need to rebuild the @t{rt_cpu.bin} file from source, to make
your own modifications, you can run @t{make wr_switch_defconfig} your own modifications, you can run @t{make wr_switch_defconfig}
in @i{wrpc-sw} and then @t{make}. Please checkout the @code{wr-switch-sw-v4.1} in @i{wrpc-sw} and then @t{make}. Please checkout the @code{wr-switch-sw-v4.2}
tag to get the exact commit. tag to get the exact commit.
@c -------------------------------------------------------------------------- @c --------------------------------------------------------------------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment