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

Use correct headers

This commit is contained in:
Rasmus Steinke 2018-07-20 16:06:26 +02:00
parent 8a689e68bc
commit 86979c8f04
1 changed files with 9 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/developer.rst
View File

@ -2,15 +2,13 @@
The Music Player Daemon - Developer's Manual
============================================
------------
Introduction
------------
============
This is a guide for those who wish to hack on the MPD source code. MPD is an open project, and we are always happy about contributions. So far, more than 150 people have contributed patches. This document is work in progress. Most of it may be incomplete yet. Please help!
----------
Code Style
----------
==========
* indent with tabs (width 8)
* don't write CPP when you can write C++: use inline functions and constexpr instead of macros
@ -20,9 +18,8 @@ Code Style
* all code must be exception-safe
* classes and functions names use CamelCase; variables are lower-case with words separated by underscore
******************
Some example code:
******************
~~~~~~~~~~~~~~~~~~
.. code-block:: c
@ -36,9 +33,9 @@ Some example code:
return xyz;
}
------------------
Hacking The Source
------------------
==================
MPD sources are managed in a git repository on
`Github <https://github.com/MusicPlayerDaemon/>`_.
@ -60,9 +57,9 @@ Configure with the options :option:`--enable-debug --enable-werror`. Enable as
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.
-----------------
Basic stgit usage
-----------------
stgit allows you to create a set of patches and refine all of them: you can go back to any patch at any time, and re-edit it (both the code and the commit message). You can reorder patches and insert new patches at any position. It encourages creating separate patches for tiny changes.
stgit needs to be initialized on a git repository:
@ -95,22 +92,19 @@ When the whole patch series is finished, convert stgit patches to git commits:
stg commit
------------------
Submitting Patches
------------------
==================
Send your patches to the mailing list:
Email: `mpd-devel <mpd-devel@musicpd.org>`_
:program:`git pull` requests are preferred.
-----------------
Development Tools
-----------------
=================
*********************
Clang Static Analyzer
*********************
---------------------
The `static analyzer <http://clang-analyzer.llvm.org/>`_ is a tool that helps find bugs. To run it on the MPD code base, install LLVM and clang. configure MPD to use clang: