oysteikt
/
mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

doc/developer.rst: remove :option: markup

This commit is contained in:
Max Kellermann 2018-10-31 13:24:52 +01:00
parent b878111404
commit 30eaae10c1
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/developer.rst
View File

@ -50,10 +50,11 @@ If you already have a clone, update it:
git pull --rebase git://github.com/MusicPlayerDaemon/MPD master git pull --rebase git://github.com/MusicPlayerDaemon/MPD master
You can do without :option:`--rebase`, but we recommend that you rebase your repository on the "master" repository all the time. You can do without :code:`--rebase`, but we recommend that you rebase
your repository on the "master" repository all the time.
Configure with the option :option:`--werror`. Enable as many plugins Configure with the option :code:`--werror`. Enable as many plugins as
as possible, to be sure that you don't break any disabled code. possible, to be sure that you don't break any disabled code.
Don't mix several changes in one single patch. Create a separate patch for every change. Tools like :program:`stgit` help you with that. This way, we can review your patches more easily, and we can pick the patches we like most first. Don't mix several changes in one single patch. Create a separate patch for every change. Tools like :program:`stgit` help you with that. This way, we can review your patches more easily, and we can pick the patches we like most first.
@ -112,7 +113,9 @@ Clang Static Analyzer
./configure --enable-debug CXX=clang++ CC=clang ... ./configure --enable-debug CXX=clang++ CC=clang ...
It is recommended to use :option:`--enable-debug`, because the analyzer takes advantage of :dfn:`assert()` calls, which are only enabled in the debug build. It is recommended to use :code:`--enable-debug`, because the analyzer
takes advantage of :dfn:`assert()` calls, which are only enabled in
the debug build.
Now run the analyzer: Now run the analyzer:
@ -120,4 +123,6 @@ Now run the analyzer:
scan-build --use-c++=clang++ --use-cc=clang make scan-build --use-c++=clang++ --use-cc=clang make
The options :option:`--use-c++` and :option:`--use-cc` are necessary because it invokes :command:`cc` for actually compiling the sources by default. That breaks, because MPD requires a C99 compiler. The options :code:`--use-c++` and :code:`--use-cc` are necessary
because it invokes :command:`cc` for actually compiling the sources by
default. That breaks, because MPD requires a C99 compiler.