Skip to content

Commit

Permalink
Slightly update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
17451k committed Jan 15, 2021
1 parent 05fb857 commit aa23b18
Show file tree
Hide file tree
Showing 3 changed files with 129 additions and 134 deletions.
14 changes: 7 additions & 7 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ For example, `CC` extension have the following list:
]
```

Obviously, execution of `/usr/bin/gcc*`will be matched, as well as
Obviously, execution of `/usr/bin/gcc` will be matched, as well as
`/usr/bin/clang`, or `/usr/local/bin/powerpc-elf-gcc-7`, so all such commands
will be treated as compilation commands and parsed accordingly.
Sometimes this list is not enough, so there is an option to change it:
Expand Down Expand Up @@ -81,7 +81,7 @@ respectively pdf files containing Graphviz output will appear.
## List of commands to parse

If you want to generate `command graph`, or `source graph`, or `call graph`,
then you need to specify which commands to parse via "CmdGraph.requires"
then you need to specify which commands to parse via `CmdGraph.requires`
option. By default all commands that are supported now are parsed,
but you can reduce their number:

Expand All @@ -93,15 +93,15 @@ but you can reduce their number:

## Presets

There is predefined set of options for the following projects that can be used
in addition to user-defined configuration:
There is a predefined set of options for the following projects that can be used
in addition to the user-defined configuration:

* Linux kernel (preset linux_kernel)
* Busybox (preset busybox_linux)
* Apache (presetsapache_linux)
* Apache (preset apache_linux)

If you want to execute Clade on one of these projects then it might be a *good
idea* to use this presets, since they will definitely save you from having
If you want to execute Clade on one of these projects, then it might be a
*good idea* to use these presets, since they will definitely save you from having
to deal with various problems and mess with the configuration:

``` shell
Expand Down
6 changes: 3 additions & 3 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ identify a command as a compilation command. You can help it by specifying
is `~/.local/bin/c_compiler`, than `CC.which_list` may be set like this:

```
"CC.which_list": ["^.*?c_compiler$"]
"CC.which_list": ["c_compiler$"]
```

If you want to parse not only commands executed by your compiler, but by system
*gcc* as well, then you can add it to the list too:
`gcc` as well, then you can add it to the list too:

```
"CC.which_list": ["^.*?c_compiler$", ""^.*gcc$"]
"CC.which_list": ["c_compiler$", ""gcc$"]
```

How to set configuration option is described in the [configuration](configuration.md) section of
Expand Down

0 comments on commit aa23b18

Please sign in to comment.