diff options
| author | Christian Hopps <chopps@labn.net> | 2023-05-17 22:26:49 -0400 |
|---|---|---|
| committer | Christian Hopps <chopps@labn.net> | 2023-05-18 09:32:32 -0400 |
| commit | 2596308a09c2b87a24165d0f98bc673e30b729d1 (patch) | |
| tree | 154dd744f80ec234f45c510908e5b3892c770b4b /doc/user/installation.rst | |
| parent | d66a297fab11348360db451f04358c426a27d746 (diff) | |
doc: configure: add configure option to generate .ccls file
`ccls` needs information from FRR build configuration to work,
so allow creation of a custom ccls config during autoconf.
Paraphrasing the doc entry: ccls is a very powerful tool that allows
dev environments to provide sophisticated IDE functionality, e.g.,
semantically aware jumps and code refactoring...
Signed-off-by: Christian Hopps <chopps@labn.net>
Diffstat (limited to 'doc/user/installation.rst')
| -rw-r--r-- | doc/user/installation.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/user/installation.rst b/doc/user/installation.rst index 2310d397cd..8e8fb24608 100644 --- a/doc/user/installation.rst +++ b/doc/user/installation.rst @@ -390,6 +390,18 @@ and the configuration files in :file:`/usr/local/etc`. The :file:`/usr/local/` installation prefix and other directories may be changed using the following options to the configuration script. +.. option:: --enable-ccls + + Enable the creation of a :file:`.ccls` file in the top level source + directory. + + Some development environments (e.g., LSP server within emacs, et al.) can + utilize :clicmd:`ccls` to provide highly sophisticated IDE features (e.g., + semantically accurate jump-to definition/reference, and even code + refactoring). The `--enable-ccls` causes :file:`configure` to generate a + configuration for the :clicmd:`ccls` command, based on the configured + FRR build environment. + .. option:: --prefix <prefix> Install architecture-independent files in `prefix` [/usr/local]. |