author | Alberto Bertogli
<albertito@blitiri.com.ar> 2010-10-10 23:05:39 UTC |
committer | Alberto Bertogli
<albertito@blitiri.com.ar> 2010-10-10 23:05:39 UTC |
parent | 37f6a98110e3bb59bbb4971241baa3a385c3f724 |
doc/guide.rst | +3 | -3 |
doc/posix.rst | +8 | -8 |
diff --git a/doc/guide.rst b/doc/guide.rst index e4ef6fc..c401b46 100644 --- a/doc/guide.rst +++ b/doc/guide.rst @@ -31,8 +31,8 @@ Code overview Let's take a look to a small (fictitious) code sample to see what's the general idea behind libfiu. -Let's say you have this code that check if there's enough free space to fit a -given file:: +Let's say you have this code that checks if there's enough free space to store +a given file:: size_t free_space() { [code to find out how much free space there is] @@ -130,7 +130,7 @@ It is recommended that you use meaningful names for your points of failure, to be able to easily identify their purpose. You can also name them hierarchically (for example, using names like *"io/write"*, *"io/read"*, and so on), to be able to enable entire groups of points of failure (like -*"io/\*"*,). To this end, any separator will do, the *'/'* is not special at +*"io/\*"*). To this end, any separator will do, the *'/'* is not special at all. diff --git a/doc/posix.rst b/doc/posix.rst index eecadbf..d10ff91 100644 --- a/doc/posix.rst +++ b/doc/posix.rst @@ -40,15 +40,15 @@ Run it several times and you can see that sometimes it works, but sometimes it doesn't, reporting an error reading, which means a *read()* failed as expected. -When fortune is run, every time fortune calls *read()* it has a 1% chance to -fail, which selects an errno at random from the list of the ones that read() -is allowed to return. If you want to select an specific errno, you can do it -by passing its numerical value using the *-i* parameter. +When fortune is run, every *read()* has a 1% chance to fail, selecting an +*errno* at random from the list of the ones that read() is allowed to return. +If you want to select an specific *errno*, you can do it by passing its +numerical value using the *-i* parameter. The name of the failure points are fixed, and there is at least one for each -function that libfiu supports injecting failures to. Not all POSIX is -included, but most of the important pieces are, and it is easily extended. See -below for details. +function that libfiu supports injecting failures to. Not all POSIX functions +are included, but most of the important pieces are, and it can be easily +extended. See below for details. To see the list of supported functions and names, see the (automatically generated) *preload/posix/function_list* file that comes in the libfiu @@ -64,7 +64,7 @@ instead of from the beginning, as *fiu-run* does. To that end, you can combine *fiu-run* with the second tool, called *fiu-ctrl*. -Let's suppose you want to see what the "top" program does when it can't open +Let's suppose we want to see what the "top" program does when it can't open files. First, we run it with *fiu-run*:: $ fiu-run -x top