mirror of
https://github.com/amadvance/snapraid.git
synced 2026-10-12 02:10:54 +00:00
Documentation fixes
This commit is contained in:
Andrea Mazzoleni
@@ -7,8 +7,8 @@ You can contact me sending an email at:
|
||||
|
||||
[email protected]
|
||||
|
||||
Please don't send support requests at this address, but use the
|
||||
SnapRAID Forum.
|
||||
Please don't send support requests at this address, but use the SnapRAID
|
||||
forum.
|
||||
|
||||
|
||||
ACKNOWLEDGMENTS
|
||||
@@ -16,12 +16,8 @@ ACKNOWLEDGMENTS
|
||||
|
||||
Special thanks to Leifi, the king of the Forum!
|
||||
|
||||
Thanks for the testing, suggestions and bug reports to klbl,
|
||||
jwill42, tholiin, uhclem, reardonia, Jens, rubylaser and the
|
||||
whole SnapRAID Forum.
|
||||
|
||||
Thanks to Maxim Tikhonov for making the Ubuntu packages.
|
||||
|
||||
Also thanks for the support to Ben_in_COSprings, Darin, micksh, RamanRB
|
||||
and the whole AVS Forum.
|
||||
Thanks for the testing, suggestions and bug reports to klbl, jwill42, tholiin,
|
||||
uhclem, reardonia, Jens, rubylaser and the whole SnapRAID Forum.
|
||||
|
||||
Also thanks for the support to Ben_in_COSprings, Darin, micksh, RamanRB and
|
||||
the whole AVS Forum.
|
||||
|
||||
@@ -1,32 +1,30 @@
|
||||
SnapRAID CHECK
|
||||
==============
|
||||
|
||||
The regression test of SnapRAID is run using the command:
|
||||
The regression test for SnapRAID is run using the command:
|
||||
|
||||
make check
|
||||
make check
|
||||
|
||||
You can also run the regression test in valgrind with:
|
||||
You can also run the regression test with Valgrind using:
|
||||
|
||||
./configure --enable-valgrind
|
||||
make check
|
||||
./configure --enable-valgrind
|
||||
make check
|
||||
|
||||
To run a coverage test you should use:
|
||||
To perform a coverage test, use the following commands:
|
||||
|
||||
./configure --enable-coverage
|
||||
make lcov_reset
|
||||
make check
|
||||
make lcov_capture
|
||||
make lcov_html
|
||||
./configure --enable-coverage
|
||||
make lcov_reset
|
||||
make check
|
||||
make lcov_capture
|
||||
make lcov_html
|
||||
|
||||
and open the file ./cov/index.html in your browser to see the results.
|
||||
Then, open the file `./cov/index.html` in your browser to view the results.
|
||||
|
||||
Please note that in the coverage analysis we exclude the handling of all
|
||||
the error conditions that result in an immediate termination of the program.
|
||||
You can recognize this excluded code because it's enclosed between
|
||||
the LCOV_EXCL_START and LCOV_EXCL_STOP keywords.
|
||||
Note that the coverage analysis excludes error-handling code that causes
|
||||
immediate program termination. This excluded code is enclosed between the
|
||||
LCOV_EXCL_START and LCOV_EXCL_STOP keywords.
|
||||
|
||||
To test with the clang static analyzer use:
|
||||
|
||||
scan-build ./configure
|
||||
scan-build make
|
||||
To test with the Clang static analyzer, use:
|
||||
|
||||
scan-build ./configure
|
||||
scan-build make
|
||||
|
||||
@@ -1,33 +1,33 @@
|
||||
SnapRAID INSTALL
|
||||
================
|
||||
|
||||
To build and install SnapRAID you need to download the source
|
||||
code from http://www.snapraid.it and unpack it with:
|
||||
To build and install SnapRAID, download the source code from http://www.snapraid.it
|
||||
and unpack it with the following commands:
|
||||
|
||||
tar xf snapraid-*.tar.gz
|
||||
tar xf snapraid-.tar.gz
|
||||
cd snapraid-*
|
||||
|
||||
To configure and build, run:
|
||||
To configure and build SnapRAID, run:
|
||||
|
||||
./configure
|
||||
make
|
||||
|
||||
To run the correctness tests for the application:
|
||||
To run the application's correctness tests, execute:
|
||||
|
||||
make check
|
||||
|
||||
If this terminates with "Success", you can install the application and
|
||||
the documentation by running:
|
||||
If the tests complete with "Success", install the application anddocumentation
|
||||
using:
|
||||
|
||||
sudo make install
|
||||
|
||||
(The snapraid application itself does not require root privileges.)
|
||||
Note: The SnapRAID application does not require root privileges to run, but
|
||||
you may need appropriate permissions to access the disks.
|
||||
|
||||
To start using SnapRAID, change the example configuration
|
||||
file snapraid.conf.example to fit your needs and copy it to /etc/snapraid.conf
|
||||
To start using SnapRAID, modify the example configuration file
|
||||
snapraid.conf.example to suit your needs and copy it to /etc/snapraid.conf.
|
||||
|
||||
To get more help, see the "Getting Started" section in the snapraid manpage
|
||||
by typing:
|
||||
For additional guidance, refer to the "Getting Started" section in the SnapRAID
|
||||
manpage by typing:
|
||||
|
||||
man snapraid
|
||||
|
||||
|
||||
+4
-5
@@ -1,9 +1,8 @@
|
||||
SnapRAID INSTALL for Windows
|
||||
============================
|
||||
|
||||
To start using SnapRAID you have to change the example configuration
|
||||
file snapraid.conf.example to fit your needs and copy it with the
|
||||
name snapraid.conf in the directory where you run snapraid.exe.
|
||||
|
||||
To get more help, see the "Getting Started" section in snapraid.txt.
|
||||
To start using SnapRAID, you need to modify the example configuration file
|
||||
snapraid.conf.example to suit your requirements. After editing, save it as
|
||||
snapraid.conf in the same directory where you run snapraid.exe.
|
||||
|
||||
For additional guidance, refer to the "Getting Started" section in snapraid.txt.
|
||||
|
||||
Reference in New Issue
Block a user