Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
W
wr-switch-sw
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
image/svg+xml
Discourse
Discourse
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Commits
Open sidebar
white-rabbit
wr-switch-sw
Commits
8a585ff6
Commit
8a585ff6
authored
May 11, 2011
by
Alessandro Rubini
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
doc: removed cruft in @node lines, now autogenerated
parent
c9917538
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
28 additions
and
28 deletions
+28
-28
wrs-build.in
doc/wrs-build.in
+14
-14
wrs-software.in
doc/wrs-software.in
+1
-1
wrs-test.in
doc/wrs-test.in
+13
-13
No files found.
doc/wrs-build.in
View file @
8a585ff6
...
...
@@ -49,7 +49,7 @@
@
headings
single
@
c
##########################################################################
@
node
Top
,
Overview
,
(
dir
),
(
dir
)
@
node
Top
@
top
Introduction
This
package
includes
the
software
build
procedures
for
the
White
...
...
@@ -71,7 +71,7 @@ Build}.
@end menu
@c ##########################################################################
@node Overview
, Quick Build, Top, Top
@node Overview
@chapter Overview
This package builds over previous work by Tomasz Wlostowski, who first
...
...
@@ -128,7 +128,7 @@ rebuilding it all from scratch.
@
end
menu
@
c
==========================================================================
@
node
Portability
,
Environment
Variables
,
Overview
,
Overview
@
node
Portability
@
section
Portability
The
scripts
in
their
current
status
are
not
expected
to
be
very
...
...
@@ -146,7 +146,7 @@ be a native GNU/Linux system; success reports about other environments
(
e
.
g
.
cygwin
)
are
welcome
,
possibly
with
associated
patches
.
@
c
==========================================================================
@
node
Environment
Variables
,
Downloading
Files
,
Portability
,
Overview
@
node
Environment
Variables
@
section
Environment
Variables
The
scripts
use
a
number
of
environment
variables
;
you
can
pre
-
set
...
...
@@ -215,7 +215,7 @@ useful to people working on the script itself, they are documented in
place
.
@
c
==========================================================================
@
node
Downloading
Files
,
The
OHWR
Repository
,
Environment
Variables
,
Overview
@
node
Downloading
Files
@
section
Downloading
Files
Every
downloaded
file
is
saved
to
the
download
directory
,
you
might
...
...
@@ -240,7 +240,7 @@ The previous policy is implemented in @i{wrs_download}, in the file
main
directory
.
@
c
==========================================================================
@
node
The
OHWR
Repository
,
Rebuilding
Parts
,
Downloading
Files
,
Overview
@
node
The
OHWR
Repository
@
section
The
OHWR
Repository
Most
of
the
code
here
(
with
the
huge
exception
of
@
i
{
buildroot
}
...
...
@@ -299,7 +299,7 @@ run:
@
end
example
@
c
==========================================================================
@
node
Rebuilding
Parts
,
,
The
OHWR
Repository
,
Overview
@
node
Rebuilding
Parts
@
section
Rebuilding
Parts
When
the
script
builds
each
part
(
sub
-
package
),
it
creates
a
file
in
...
...
@@ -315,7 +315,7 @@ As an alternative, you can run the individual script within
@
i
{
scripts
/},
after
setting
the
proper
environment
variables
.
@
c
##########################################################################
@
node
Quick
Build
,
The
Compiler
,
Overview
,
Top
@
node
Quick
Build
@
chapter
Quick
Build
If
you
just
want
to
build
stuff
,
with
no
concern
about
network
...
...
@@ -377,7 +377,7 @@ rename) the @i{output/} directory, and re-run.
@
c
##########################################################################
@
node
The
Compiler
,
Buildroot
,
Quick
Build
,
Top
@
node
The
Compiler
@
chapter
The
Compiler
The
predefined
compiler
used
here
is
the
one
built
by
@
i
{
buildroot
}.
...
...
@@ -393,7 +393,7 @@ the boot loader and kernel by themselves, and avoid it when compiling
the
complete
package
.
@
c
##########################################################################
@
node
Buildroot
,
The
IPL
,
The
Compiler
,
Top
@
node
Buildroot
@
chapter
Buildroot
The
distribution
being
used
here
is
@
i
{
buildroot
}.
It
is
the
first
...
...
@@ -431,7 +431,7 @@ Note that if the variable is not pointing to a regular file it is
ignored
with
a
simple
warning
--
rather
than
stopping
the
build
procedure
.
@
c
##########################################################################
@
node
The
IPL
,
The
Boot
Loader
,
Buildroot
,
Top
@
node
The
IPL
@
chapter
The
IPL
The
IPL
being
used
is
@
i
{
AT91Bootstrap
-
1.11
},
with
a
specific
patch
...
...
@@ -443,7 +443,7 @@ After compilation, @code{images/dataflash_whiterabbit-mch.bin} is the
binary
to
be
loaded
in
the
actual
hardware
.
@
c
##########################################################################
@
node
The
Boot
Loader
,
The
Linux
Kernel
,
The
IPL
,
Top
@
node
The
Boot
Loader
@
chapter
The
Boot
Loader
The
boot
loader
in
use
is
@
i
{
u
-
boot
-
1.3.4
},
with
a
specific
patch
for
...
...
@@ -457,7 +457,7 @@ The ELF version is copied to @i{images} as well, as
useful
--
or
may
not
.
@
c
##########################################################################
@
node
The
Linux
Kernel
,
The
Complete
Filesystem
,
The
Boot
Loader
,
Top
@
node
The
Linux
Kernel
@
chapter
The
Linux
Kernel
The
kernel
is
currently
version
2.6.35
,
compiled
from
an
uncompressed
...
...
@@ -484,7 +484,7 @@ Note that if the variable is not pointing to a regular file it is
ignored
with
a
simple
warning
--
rather
than
stopping
the
build
procedure
.
@
c
##########################################################################
@
node
The
Complete
Filesystem
,
,
The
Linux
Kernel
,
Top
@
node
The
Complete
Filesystem
@
chapter
The
Complete
Filesystem
Not
compiled
by
this
package
,
yet
.
...
...
doc/wrs-software.in
View file @
8a585ff6
...
...
@@ -48,7 +48,7 @@
@headings single
@c ##########################################################################
@node Top
, How is Testing Implemented, (dir), (dir)
@node Top
@top Introduction
This package is meant to include all white-rabbit software.
...
...
doc/wrs-test.in
View file @
8a585ff6
...
...
@@ -50,7 +50,7 @@
@headings single
@c ##########################################################################
@node Top
, How is Testing Implemented, (dir), (dir)
@node Top
@top Introduction
This small software package has been developed in the context of the
...
...
@@ -87,7 +87,7 @@ first release only includes partial documentation and no code at all.
@end menu
@c ##########################################################################
@node How is Testing Implemented
, Description of the Tests, Top, Top
@node How is Testing Implemented
@chapter How is Testing Implemented
Testing the performances of an Ethernet switch is a generic task,
...
...
@@ -103,7 +103,7 @@ on hardware timestamping whenever possible.
@end menu
@c ==========================================================================
@node RFC Compliance
, Network Timestamping Overview, How is Testing Implemented, How is Testing Implemented
@node RFC Compliance
@section RFC Compliance
The relevant RFC Documents are included in the @code
{
rfc
}
subdirectory
...
...
@@ -165,7 +165,7 @@ they make requirements for
@c ==========================================================================
@node Network Timestamping Overview
, Server and Client, RFC Compliance, How is Testing Implemented
@node Network Timestamping Overview
@section Network Timestamping Overview
This section describes the hardware timestamp mechanism of the Linux
...
...
@@ -196,7 +196,7 @@ source files or data structures.
@end menu
@c --------------------------------------------------------------------------
@node Timestamping Implementation
, Timestamping Use, Network Timestamping Overview, Network Timestamping Overview
@node Timestamping Implementation
@subsection Timestamping Implementation
This is a description of stamping seen from the point of view of
...
...
@@ -399,7 +399,7 @@ Actually, the only difference in the code is that the structure
with the two @i
{
ktime
}
stamps is local and not in the @i
{
skb
}
itself.
@c --------------------------------------------------------------------------
@node Timestamping Use
, Using HW Stamps on RTL8169, Timestamping Implementation, Network Timestamping Overview
@node Timestamping Use
@subsection Timestamping Use
When you receive a packet you can get the timing data together with
...
...
@@ -451,7 +451,7 @@ the following tasks:
@end table
@c --------------------------------------------------------------------------
@node Using HW Stamps on RTL8169
, Using HW Stamps on the 82575 device, Timestamping Use, Network Timestamping Overview
@node Using HW Stamps on RTL8169
@subsection Using HW Stamps on RTL8169
The directory @i
{
patches
}
in this package includes a few patches to
...
...
@@ -504,7 +504,7 @@ be run on a system with a loopback Ethernet cable, among the two
self-connected interfaces.
@c --------------------------------------------------------------------------
@node Using HW Stamps on the 82575 device
, White Rabbit Extensions, Using HW Stamps on RTL8169, Network Timestamping Overview
@node Using HW Stamps on the 82575 device
@subsection Using HW Stamps on the 82575 device
@b
{
NOTE: This is currently bugged, the numbers are repeated, I leave
...
...
@@ -534,14 +534,14 @@ get only the software stamp. This is a sample run with the simple
@end smallexample
@c --------------------------------------------------------------------------
@node White Rabbit Extensions
, , Using HW Stamps on the 82575 device, Network Timestamping Overview
@node White Rabbit Extensions
@subsection White Rabbit Extensions
@c FIXME:
To be done.
@c ==========================================================================
@node Server and Client
, , Network Timestamping Overview, How is Testing Implemented
@node Server and Client
@section Server and Client
The test system has been designed as a client-server system, even
...
...
@@ -564,21 +564,21 @@ multi-process in later revisions of this packages.
@c FIXME: complete server and client
@c ##########################################################################
@node Description of the Tests
, How to Run the Test Suite, How is Testing Implemented, Top
@node Description of the Tests
@chapter Description of the Tests
@c FIXME:
To be done.
@c ##########################################################################
@node How to Run the Test Suite
, Results Collected on Various Switches, Description of the Tests, Top
@node How to Run the Test Suite
@chapter How to Run the Test Suite
@c FIXME:
To be done.
@c ##########################################################################
@node Results Collected on Various Switches
, , How to Run the Test Suite, Top
@node Results Collected on Various Switches
@chapter Results Collected on Various Switches
@c FIXME:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment