From 51951c9442d7305fbf2e05f91b549998c1598ade Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Wed, 18 Jul 2018 12:25:33 +0200 Subject: [PATCH] doc: remove developer.xml, was converted to Sphinx --- Makefile.am | 6 +- doc/developer.xml | 231 ---------------------------------------------- 2 files changed, 1 insertion(+), 236 deletions(-) delete mode 100644 doc/developer.xml diff --git a/Makefile.am b/Makefile.am index 73c7d194b..7b1ea36ef 100644 --- a/Makefile.am +++ b/Makefile.am @@ -2512,7 +2512,7 @@ endif man_MANS = doc/mpd.1 doc/mpd.conf.5 doc_DATA = AUTHORS COPYING NEWS README.md doc/mpdconf.example -DOCBOOK_FILES = doc/protocol.xml doc/user.xml doc/developer.xml +DOCBOOK_FILES = doc/protocol.xml doc/user.xml if ENABLE_DOCUMENTATION protocoldir = $(docdir)/protocol @@ -2521,9 +2521,6 @@ protocol_DATA = $(wildcard doc/protocol/*.html) userdir = $(docdir)/user user_DATA = $(wildcard doc/user/*.html) -developerdir = $(docdir)/developer -developer_DATA = $(wildcard doc/developer/*.html) - DOCBOOK_HTML = $(patsubst %.xml,%/index.html,$(DOCBOOK_FILES)) DOCBOOK_INCLUDES = $(wildcard $(srcdir)/doc/include/*.xml) @@ -2561,7 +2558,6 @@ upload: $(DOCBOOK_HTML) doc/api/html/index.html --chmod=Dug+rwx,Do+rx,Fug+rw,Fo+r \ --include=protocol --include=protocol/** \ --include=user --include=user/** \ - --include=developer --include=developer/** \ --include=api --include=api/** \ --exclude=* diff --git a/doc/developer.xml b/doc/developer.xml deleted file mode 100644 index c2a4c164e..000000000 --- a/doc/developer.xml +++ /dev/null @@ -1,231 +0,0 @@ - - - - - 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 - - - - - - comment your code, document your APIs - - - - - - the code should be C++14 compliant, and must compile with - GCC 6.0 and - clang 3.4 - - - - - - report error conditions with C++ exceptions, preferable - derived from std::runtime_error - - - - - - all code must be exception-safe - - - - - - classes and functions names use CamelCase; variables are - lower-case with words separated by underscore - - - - - - Some example code: - - - static inline int -Foo(const char *abc, int xyz) -{ - if (abc == nullptr) { - LogWarning("Foo happened!"); - return -1; - } - - return xyz; -} - - - - - - - Hacking The Source - - - MPD sources are managed in a git repository on GitHub. - - - - Always write your code against the latest git: - - - git clone git://github.com/MusicPlayerDaemon/MPD - - - If you already have a clone, update it: - - - git pull --rebase git://github.com/MusicPlayerDaemon/MPD master - - - You can do without "--rebase", but we recommend that you rebase - your repository on the "master" repository all the time. - - - - Configure with the options . Enable as many plugins as 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 - 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: stg init - - - - Before you edit the code, create a patch: stg new - my-patch-name (stgit now asks you for the commit message). - - - - Now edit the code. Once you're finished, you have to "refresh" - the patch, i.e. your edits are incorporated into the patch you - have created: stg refresh - - - - You may now continue editing the same patch, and refresh it as - often as you like. Create more patches, edit and refresh them. - - - - To view the list of patches, type stg series. To go back to a - specific patch, type stg goto my-patch-name; now you can - re-edit it (don't forget stg refresh when you're finished with - that patch). - - - - When the whole patch series is finished, convert stgit patches - to git commits: stg commit - -
- - - - Submitting Patches - - - Send your patches to the mailing list: - mpd-devel@musicpd.org (subscribe - here) - - - - git pull requests are preferred. - - - - - Development Tools - -
- Clang Static Analyzer - - - The clang static - analyzer is a tool that helps find bugs. To run it on - the MPD code base, install LLVM and clang. Configure MPD to - use clang: - - - ./configure --enable-debug CXX=clang++ CC=clang ... - - - It is recommended to use , - because the analyzer takes advantage of - assert() calls, which are only enabled in - the debug build. - - - - Now run the analyzer: - - - scan-build --use-c++=clang++ --use-cc=clang make - - - The options and - are necessary because it invokes - cc for actually compiling the sources by - default. That breaks, because MPD requires a C99 compiler. - -
- -