Merge branch 't/configure_improvements'

[paraslash.git] / web / manual.m4

diff --git a/web/manual.m4 b/web/manual.m4
index cd06cccd192a7ccf3791d7c9f8ae31fca23c8f09..5926b55536c736c0bd8f031bd596d51e31587fbb 100644 (file)
--- a/web/manual.m4
+++ b/web/manual.m4
@@ -280,7 +280,11 @@ might need to tell the configure script where to find them. Try
        ./configure --help
 
 to see a list of options. If the paraslash package was compiled
-successfully, execute as root,
+successfully, execute (optionally)
+
+       make test
+
+to run the paraslash test suite. If all tests pass, execute as root
 
        make install
 
@@ -1347,12 +1351,12 @@ REFERENCE(Forward error correction, FEC) below.
 Streams with headers and headerless streams
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-For ogg vorbis and wma streams, not all information needed to decode
-the stream is contained in each data chunk but only in the audio
-file header of the container format. Therefore clients must be able
-to obtain this information in case streaming starts in the middle of
-the file or if para_audiod is started while para_server is already
-sending a stream.
+For OGG/Vorbis, OGG/Speex and wma streams, some of the information
+needed to decode the stream is only contained in the audio file
+header of the container format but not in each data chunk. Clients
+must be able to obtain this information in case streaming starts in
+the middle of the file or if para_audiod is started while para_server
+is already sending a stream.
 
 This is accomplished in different ways, depending on the streaming
 protocol. For connection-oriented streams (HTTP, DCCP) the audio file
@@ -1631,12 +1635,12 @@ A paraslash writer acts as a data sink that consumes but does not
 produce audio data. Paraslash writers operate on the client side and
 are contained in para_audiod and in the stand-alone tool para_write.
 
-The para_write program reads uncompressed 16 bit audio data from
-STDIN. If this data starts with a wav header, sample rate and channel
-count are read from the header. Otherwise CD audio (44.1KHz stereo)
-is assumed but this can be overridden by command line options.
-para_audiod, on the other hand, obtains the sample rate and the number
-of channels from the decoder.
+The para_write program reads uncompressed audio data from STDIN. If
+this data starts with a wav header, sample rate, sample format and
+channel count are read from the header. Otherwise CD audio (44.1KHz
+16 bit little endian, stereo) is assumed but this can be overridden
+by command line options. para_audiod, on the other hand, obtains
+the sample rate and the number of channels from the decoder.
 
 Like receivers and filters, each writer has an individual set of
 command line options, and for para_audiod writers can be configured
@@ -1844,7 +1848,7 @@ New development does not usually happen on "master", however.
 Instead, a separate topic branch is forked from the tip of "master",
 and it first is tested in isolation; Usually there are a handful such
 topic branches that are running ahead of "master". The tip of these
-branches is not published in the public repository, to keep the number
+branches is not published in the public repository to keep the number
 of branches that downstream developers need to worry about low.
 
 The quality of topic branches varies widely. Some of them start out as
@@ -1866,6 +1870,11 @@ have been merged into "next" are usually not rebased, and you can find
 the tip of topic branches you are interested in from the output of
 "git log next"). You should be able to safely build on top of them.
 
+However, at times "next" will be rebuilt from the tip of "master" to
+get rid of merge commits that will never be in "master. The commit
+that replaces "next" will usually have the identical tree, but it
+will have different ancestry from the tip of "master".
+
 The "pu" (proposed updates) branch bundles the remainder of the
 topic branches.  The "pu" branch, and topic branches that are only in
 "pu", are subject to rebasing in general.  By the above definition