diff options
Diffstat (limited to 'docs')
59 files changed, 7804 insertions, 0 deletions
diff --git a/docs/CODE_GUIDELINES.md b/docs/CODE_GUIDELINES.md new file mode 100644 index 0000000..8cd9a18 --- /dev/null +++ b/docs/CODE_GUIDELINES.md @@ -0,0 +1,767 @@ +# Code Guidelines + + + +## Table of Contents +* [1. Motivation](#1-motivation) +* [2. Language standard](#2-language-standard) +* [3. Formatting](#3-formatting) + * [3.1. Braces](#31-braces) + * [3.2. Indentation](#32-indentation) + * [3.3. Control statements](#33-control-statements) + * [3.3.1. if else](#331-if-else) + * [3.3.2. switch case](#332-switch-case) + * [3.3.3. try catch](#333-try-catch) + * [3.4. Whitespace](#34-whitespace) + * [3.5. Vertical alignment](#35-vertical-alignment) +* [4. Statements](#4-statements) +* [5. Declarations](#5-declarations) + * [5.1. Multiple declarations](#51-multiple-declarations) + * [5.2. Pointer and reference types](#52-pointer-and-reference-types) + * [5.3. const and other modifiers](#53-const-and-other-modifiers) + * [5.4. Initialization](#54-initialization) +* [6. Scoping](#6-scoping) + * [6.1. Namespaces](#61-namespaces) + * [6.2. Local functions](#62-local-functions) +* [7. Headers](#7-headers) +* [8. Naming](#8-naming) + * [8.1. Namespaces](#81-namespaces) + * [8.2. Constants](#82-constants) + * [8.3. Enums](#83-enums) + * [8.4. Interfaces](#84-interfaces) + * [8.5. Classes](#85-classes) + * [8.6. Methods](#86-methods) + * [8.7. Variables](#87-variables) + * [Member variables](#member-variables) + * [Global variables](#global-variables) +* [9. Comments](#9-comments) + * [9.1. General](#91-general) + * [9.2. Doxygen](#92-doxygen) +* [10. Logging](#10-logging) +* [11. Classes](#11-classes) + * [11.1. Member visibility](#111-member-visibility) + * [11.2. Const correctness](#112-const-correctness) + * [11.3. Overriding virtual functions](#113-overriding-virtual-functions) + * [11.4. Default member initialization](#114-default-member-initialization) + * [11.5. Destructors in interfaces](#115-destructors-in-interfaces) + * [11.6. Constructor Initialization Lists](#116-constructor-initialization-lists) +* [12. Other conventions](#12-other-conventions) + * [12.1. Output parameters](#121-output-parameters) + * [12.2. Casts](#122-casts) + * [12.3. `NULL` vs `nullptr`](#123-null-vs-nullptr) + * [12.4. auto](#124-auto) + * [12.5. `for` loops](#125-for-loops) + * [12.6. Include guards](#126-include-guards) + * [12.7. Type aliases](#127-type-aliases) + * [12.8. `goto`](#128goto) + * [12.9. Macros](#129-macros) + * [12.10. constexpr](#1210-constexpr) + +## 1. Motivation +When working in a large group, the two most important values are readability and maintainability. We code for other people, not computers. To accomplish these goals, we have created a unified set of code conventions. + +In the repository root directory, there is a [`.clang-format`](https://github.com/xbmc/xbmc/blob/master/.clang-format) file that implements the rules as specified here. You are encouraged to run [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html) on any newly created files. It is currently not recommended to do so on preexisting files because all the formatting changes will clutter your commits and pull request. + +When you create a pull request, the PR build job will run `clang-format` on your commits and provide patches for any parts that don't satisfy the current `.clang-format` rules. You should apply these patches and amend your pull request accordingly. + +Conventions can be bent or broken in the interest of making code more readable and maintainable. However, if you submit a patch that contains excessive style conflicts, you may be asked to improve your code before your pull request is reviewed. + +**[back to top](#table-of-contents)** + +## 2. Language standard + +We currently target the C++17 language standard. Do use C++17 features when possible (and supported by all target platforms). Do not use C++20 features. + +**[back to top](#table-of-contents)** + +## 3. Formatting + +### Line length +The `ColumnLimit` in `.clang-format` is set to `100` which defines line length (in general where lines should be broken) that allows two editors side by side on a 1080p screen for diffs. + +### 3.1. Braces +Curly braces always go on a new line. + +```cpp +for (int i = 0; i < t; i++) +{ + [...] +} + +if (true) +{ + [...] +} + +class Dummy +{ + [...] +}; +``` + +### 3.2. Indentation +Use spaces as tab policy with an indentation size of 2. +Opening curly braces increase the level of indentation. Closing curly braces decrease the level of indentation. + +**Exception:** Do not indent namespaces to simplify nesting them and wrapping *.cpp* files in a namespace. + +```cpp +namespace KODI +{ +namespace UTILS +{ + +class ILogger +{ +public: + virtual void Log(...) = 0; + virtual ~ILogger() {} +} + +} +} +``` + +### 3.3. Control statements +Insert a new line before every: +* else in an if statement +* catch in a try statement +* while in a do statement + +#### 3.3.1. if else +Put the consequent on a new line if not in curly braces anyway. Keep `else if` statements on one line. + +```cpp +if (true) + return; + +if (true) +{ + [...] +} +else if (false) +{ + return; +} +else + return; +``` + +#### 3.3.2. switch case + +```cpp +switch (cmd) +{ + case x: + { + doSomething(); + break; + } + case x: + case z: + return true; + default: + doSomething(); +} +``` + +#### 3.3.3. try catch + +```cpp +try +{ + [...] +} +catch (std::exception& e) +{ + [...] + throw; +} +catch (...) +{ + [...] +} +``` + +### 3.4. Whitespace +Conventional operators have to be surrounded by one space on each side. +```cpp +a = (b + c) * d; +``` +Control statement keywords have to be separated from opening parentheses by one space. +```cpp +while (true); +for (int i = 0; i < x; i++); +``` +Commas have to be followed by one space. +```cpp +void Dummy::Method(int a, int b, int c); +``` +Initializer lists have one space after each element (including comma), but no surrounding spaces. +```cpp +constexpr int aNiceArray[] = {1, 2, 3}; +``` + +### 3.5. Vertical alignment +Do not use whitespace to vertically align around operators or values. This causes problems on code review if one needs to realign all values to their new position, producing unnecessarily large diffs. + +✅ Good: +```cpp +int value1{1}; +int value2{2}; +CExampleClass* exampleClass{}; +CBiggerExampleClass* biggerExampleClass{}; +exampleClass = new CExampleClass(value1, value2); +biggerExampleClass = new CBiggerExampleClass(value1, value2); +exampleClass->InitExample(); +biggerExampleClass->InitExample(); +``` + +❌ Bad: +```cpp +int value1 {1}; +int value2 {2}; +[...] +CExampleClass *exampleClass {}; +CBiggerExampleClass *biggerExampleClass {}; +[...] +exampleClass = new CExampleClass (value1, value2); +biggerExampleClass = new CBiggerExampleClass(value1, value2); +[...] +exampleClass ->InitExample(); +biggerExampleClass->InitExample(); +``` + +### 3.6. Superfluous `void` + +Do not write `void` in empty function parameter declarations. + +✅ Good: +```cpp +void Test(); +``` + +❌ Bad: +```cpp +void Test(void); +``` + +### 3.7. Exceptions to the Formatting Rules For Better Readability +There are some special situations where vertical alignment and longer lines does greatly aid readability, for example the initialization of some table-like multiple row structures. In these **rare** cases exceptions can be made to the formatting rules on vertical alignment, and the defined line length can be exceeded. + +To prevent the layout from being reformatted, tell `clang-format` to [disable formatting](https://clang.llvm.org/docs/ClangFormatStyleOptions.html#disabling-formatting-on-a-piece-of-code) on that section of code by surrounding it with the special comments `// clang-format off` and `// clang-format on`. +For example: +``` +// clang-format off +static const CGUIDialogMediaFilter::Filter filterList[] = { + { "movies", FieldTitle, 556, SettingType::String, "edit", "string", CDatabaseQueryRule::OPERATOR_CONTAINS }, + { "movies", FieldRating, 563, SettingType::Number, "range", "number", CDatabaseQueryRule::OPERATOR_BETWEEN }, + { "movies", FieldUserRating, 38018, SettingType::Integer, "range", "integer", CDatabaseQueryRule::OPERATOR_BETWEEN }, + ... + { "songs", FieldSource, 39030, SettingType::List, "list", "string", CDatabaseQueryRule::OPERATOR_EQUALS }, +}; +// clang-format on + ``` +The other code guidelines will still need to be applied within the delimited lines of code, but with `clang-format` off care will be needed to check these manually. Using vertical alignment means that sometimes the entire block of code may need to be realigned, good judgement should be used in each case with the objective of preserving readability yet minimising impact. + +This is to be used with discretion, marking large amounts of code to be left unformatted by `clang-format` without reasonable justification will be rejected. + +**[back to top](#table-of-contents)** + +## 4. Statements + +### 4.1. Multiple statements +Do not put multiple statements on a single line. Always use a new line for a new statement. It is much easier to debug if one can pinpoint a precise line number. + +✅ Good: +```cpp +std::vector<std::string> test; +test.push_back("foobar"); +``` + +❌ Bad: +```cpp +std::vector<std::string> test; test.push_back("foobar"); +``` + +### 4.2. `switch` default case + +In every `switch` structure, always include a `default` case, unless switching on an enum and all enum values are explicitly handled. + +**[back to top](#table-of-contents)** + +## 5. Declarations + +### 5.1. Multiple declarations +Do not put multiple declarations on a single line. This avoids confusion with differing pointers, references, and initialization values on the same line (cf. [ISO C++ guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#es10-declare-one-name-only-per-declaration)). + +✅ Good: +```cpp +char* a; +char b; +``` + +❌ Bad: +```cpp +char* a, b; +``` + +### 5.2. Pointer and reference types +Left-align `*` and `&` to the base type they modify. + +✅ Good: +```cpp +char* a; +void test(const std::string& b); +``` + +❌ Bad: +```cpp +char *a; +char * b; +void test(const std::string &b); +``` + +(This is adopted from the HP C++ Coding Guidelines: "The characters * and & are to be written with the type of variables instead of with the name of variables in order to emphasize that they are part of the type definition.") + +### 5.3. `const` and other modifiers +Place `const` and similar modifiers in front of the type they modify. + +✅ Good: +```cpp +void Test(const std::string& a); +const int* const someIntPointer; +``` + +❌ Bad: +```cpp +void Test(std::string const& a); +int const * const someIntPointer; +``` + +### 5.4. Initialization + +Make sure that variables are initialized appropriately at declaration or soon afterwards. This is especially important for fundamental type variables that do not have any constructor. Zero-initialize with `{}`. + +✅ Good: +```cpp +int x{}; +int* y{}; +CLog::Log("test: {} {}", x, y); +``` + +❌ Bad: +```cpp +int x; // used uninitialized +int* y = nullptr; // default-initialization not using {} +CLog::Log("test: {} {}", x, y); +``` + +In general, prefer the `{}` initializer syntax over alternatives. This syntax is less ambiguous and disallows narrowing (cf. [ISO C++ guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Res-list)). + +✅ Good: +```cpp +int x{5}; +int y{x}; +``` + +**[back to top](#table-of-contents)** + +## 6. Scoping + +### 6.1. Namespaces + +Try to put all code into appropriate namespaces (e.g. following directory structure) and avoid polluting the global namespace. + +### 6.2. Local functions + +Put functions local to a compilation unit into an anonymous namespace. + +✅ Good: +```cpp +namespace +{ + +void test(); + +} +``` + +❌ Bad: +```cpp +static void test(); +``` + +**[back to top](#table-of-contents)** + +## 7. Headers +Included header files have to be sorted (case sensitive) alphabetically to prevent duplicates and allow better overview, with an empty line clearly separating sections. + +Header order has to be: +* Own header file +* Other Kodi includes (platform independent) +* Other Kodi includes (platform specific) +* C and C++ system files +* Other libraries' header files +* special Kodi headers (PlatformDefs.h, system.h and system_gl.h) + +```cpp +#include "PVRManager.h" + +#include "Application.h" +#include "ServiceBroker.h" +#include "addons/AddonInstaller.h" +#include "dialogs/GUIDialogExtendedProgressBar.h" +#include "messaging/ApplicationMessenger.h" +#include "messaging/ThreadMessage.h" +#include "messaging/helpers/DialogHelper.h" +#include "music/MusicDatabase.h" +#include "music/tags/MusicInfoTag.h" +#include "network/Network.h" +#include "pvr/addons/PVRClients.h" +#include "pvr/channels/PVRChannel.h" +#include "settings/Settings.h" +#include "threads/SingleLock.h" +#include "utils/JobManager.h" +#include "utils/Variant.h" +#include "utils/log.h" +#include "video/VideoDatabase.h" + +#include <cassert> +#include <utility> + +#include <libavutil/pixfmt.h> +``` + +If the headers aren't sorted, either do your best to match the existing order, or precede your commit with an alphabetization commit. + +If possible, avoid including headers in another header. Instead, you can forward-declare the class and use a `std::unique_ptr` (or similar): + +```cpp +class CFileItem; + +class Example +{ + ... + std::unique_ptr<CFileItem> m_fileItem; +} +``` + +**[back to top](#table-of-contents)** + +## 8. Naming +### 8.1. Namespaces +Use upper case with underscores. +```cpp +namespace KODI +{ +[...] +} +``` + +### 8.2. Constants +Use upper case with underscores. +```cpp +constexpr int MY_CONSTANT = 1; +``` + +### 8.3. Enums +Use PascalCase for the enum name and upper case with underscores for the values. +```cpp +enum class Dummy +{ + VALUE_X, + VALUE_Y +}; +``` + +### 8.4. Interfaces +Use PascalCase and prefix with an uppercase I. Filename has to match the interface name without the prefixed I, e.g. Logger.h +```cpp +class ILogger +{ +public: + virtual void Log(...) = 0; + virtual ~ILogger() {} +} +``` + +### 8.5. Classes +Use PascalCase and prefix with an uppercase C. Filename has to match the class name without the prefixed C, e.g. Logger.cpp +```cpp +class CLogger : public ILogger +{ +public: + void Log(...) override; +} +``` + +### 8.6. Methods +Use PascalCase always, uppercasing the first letter even if the methods are private or protected. +```cpp +void MyDummyClass::DoSomething(); +``` + +### 8.7. Variables +Use CamelCase. Type prefixing (Systems Hungarian notation) is discouraged. + +#### Member variables +Prefix non-static member variables with `m_`. Prefix static member variables with `ms_`. +```cpp +int m_variableA; +static int ms_variableB; +``` + +#### Global variables +Prefix global variables with `g_` +```cpp +int g_globalVariableA; +``` +**WARNING:** Avoid use of globals as far as reasonably possible. We generally do not want to introduce new global variables. + +**[back to top](#table-of-contents)** + +## 9. Comments + +### 9.1. General + +Use `// ` for inline single-line and multi-line comments. Use `/* */` for the copyright comment at the beginning of the file. SPDX license headers are required for all code files (see example below). + +✅ Good: +```cpp +/* + * Copyright (C) 2005-2018 Team Kodi + * This file is part of Kodi - https://kodi.tv + * + * SPDX-License-Identifier: GPL-2.0-or-later + * See LICENSES/README.md for more information. + */ + +// Nice comment + +// This can also continue for multiple lines: +// I am the second line. +``` + +❌ Bad: +```cpp +/* A comment */ +//another comment +``` + +### 9.2. Doxygen + +New classes and functions are expected to have Doxygen comments describing their purpose, parameters, and behavior in the header file. However, do not describe trivialities - it only adds visual noise. Use the Qt style with exclamation mark (`/*! */`) and backslash for doxygen commands (e.g. `\brief`). + +✅ Good: +```cpp +/*! + * \brief Splits the given input string using the given delimiter into separate strings. + * + * If the given input string is empty, nothing will be put into the target iterator. + * + * \param destination the beginning of the destination range + * \param input input string to be split + * \param delimiter delimiter to be used to split the input string + * \param maxStrings (optional) maximum number of splitted strings + * \return output iterator to the element in the destination range one past the last element + * that was put there + */ +template<typename OutputIt> +static OutputIt SplitTo(OutputIt destination, const std::string& input, const std::string& delimiter, unsigned int maxStrings = 0); +``` + +❌ Bad: +```cpp +/** + * @brief Function for documentation purposes (javadoc style) + */ +void TestFunction(); + +void ReallyComplicatedFunction(); // does something really complicated + +/*! + * \brief Frobnicate a parameter + * \param param parameter to frobnicate + * \result frobnication result + */ +int Frobnicate(int param); +``` + +**[back to top](#table-of-contents)** + +## 10. Logging + +Use the provided logging function `CLog::Log`. Do not log to standard output or standard error using e.g. `printf` or `std::cout`. + +The `Log` function uses the [fmt library](http://fmtlib.net/) for formatting log messages. Basically, you can use `{}` as placeholder for anything and list the parameters to insert after the message similarly to `printf`. See [here](http://fmtlib.net/latest/syntax.html) for the detailed syntax and below for an example. + +✅ Good: +```cpp +CLog::Log(LOGDEBUG, "Window size: {}x{}", width, height); +``` + +❌ Bad: +```cpp +CLog::Log(LOGWARNING, "Window size: %dx%d", width, height); // printf-style format strings are possible, but discouraged; also the message does not warrant the warning level +printf("Window size: %dx%d", width, height); +std::cout << "Window size: " << width << "x" << height << std::endl; +``` + +The predefined logging levels are `DEBUG`, `INFO`, `NOTICE`, `WARNING`, `ERROR`, `SEVERE`, and `FATAL`. Use anything `INFO` and above sparingly since it will be written to the log by default. Too many messages will clutter the log and reduce visibility of important information. `DEBUG` messages are only written when debug logging is enabled. + +## 11. Classes + +### 11.1. Member visibility + +Make class data members `private`. Think twice before using `protected` for data members and functions, as its level of encapsulation is effectively equivalent to `public`. + +### 11.2. Const correctness + +Try to mark member functions of classes as `const` whenever reasonable. + +### 11.3. Overriding virtual functions + +When overriding virtual functions of a base class, add the `override` keyword. Do not add the `virtual` keyword. + +✅ Good: +```cpp +class CLogger : public ILogger +{ +public: + void Log(...) override; +} +``` + +❌ Bad: +```cpp +class CLogger : public ILogger +{ +public: + virtual void Log(...) override; +} +``` + +### 11.4. Default member initialization +Use default member initialization instead of initializer lists or constructor assignments whenever it makes sense. +```cpp +class Foo +{ + bool bar{false}; +}; +``` + +### 11.5. Destructors in interfaces + +A class with any virtual functions should have a destructor that is either public and virtual or else protected and non-virtual (cf. [ISO C++ guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rc-dtor-virtual)). + +### 11.6. Constructor Initialization Lists + +For lines up to [line length](#line-length) everything stays on one line, excluding the braces which must be on the following lines. + +```cpp +MyClass::CMyClass(bool bBoolArg, int iIntegerArg) : m_bArg(bBoolArg), m_iArg(iIntegerArg) +{ +} +``` + +For longer lines, break before colon and after comma. + +```cpp +MyClass::CMyClass(bool bBoolArg, + int iIntegerArg, + const std::string& strSomeText, + const std::shared_ptr<CMyOtherClass>& myOtherClass) + : m_bBoolArg(bBoolArg), + m_iIntegerArg(iIntegerArg), + m_strSomeText(strSomeText), + m_myOtherClass(myOtherClass) +{ +} +``` + +## 12. Other conventions + +### 12.1. Output parameters +For functions that have multiple output values, prefer using a `struct` or `tuple` return value over output parameters that use pointers or references (cf. [ISO C++ guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rf-out-multi)). In general, try to avoid output parameters completely (cf. [ISO C++ guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rf-out), [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html#Output_Parameters)). At the function call site, it is completely invisible that actually a reference is being passed and the value might be modified. Return semantics make it clear what is happening. + +### 12.2. Casts +New code has to use C++ style casts and not older C style casts. When modifying existing code the developer can choose to update it to C++ style casts or leave as is. Whenever a `dynamic_cast` is used to cast to a pointer type, the result can be `nullptr` and needs to be checked accordingly. + +### 12.3. `NULL` vs `nullptr` +Prefer the use of `nullptr` instead of `NULL`. `nullptr` is a typesafe version and as such can't be implicitly converted to `int` or anything else. + +### 12.4. `auto` + +Feel free to use `auto` wherever it improves readability, which is not always the case. Good places are iterators or when dealing with containers. Bad places are code that expects a certain type that is not immediately clear from the context. + +✅ Good: +```cpp +auto i = var.begin(); + +std::vector<CSizeInt> list; +for (const auto j : list) +{ + [...] +} +``` + +❌ Bad: +```cpp +std::map<std::string, std::vector<int>>::iterator i = var.begin(); +``` + +### 12.5. `for` loops +Use range-based for loops wherever it makes sense. If iterators are used, see above about using `auto`. +```cpp +for (const auto& : var) +{ + [...] +} +``` +Remove `const` if the value has to be modified. Do not use references to fundamental types that are not modified. + +### 12.6. Include guards + +Use `#pragma once`. + +✅ Good: +```cpp +#pragma once +``` + +❌ Bad: +```cpp +#ifndef SOME_FILE_H_INCLUDED +#define SOME_FILE_H_INCLUDED +[...] +#endif +``` + +### 12.7. Type aliases + +Use the C++ `using` syntax when aliasing types (encouraged when it improves readability). + +✅ Good: +```cpp +using SizeType = int; +``` + +❌ Bad: +```cpp +typedef int SizeType; +``` + +### 12.8. `goto` + +Usage of `goto` is discouraged. + +### 12.9. Macros + +Try to avoid using C macros. In many cases, they can be easily substituted with other non-macro constructs. + +### 12.10. `constexpr` + +Prefer `constexpr` over `const` for constants when possible. Try to mark functions `constexpr` when reasonable. + +**[back to top](#table-of-contents)** diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..650dbad --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,36 @@ + + +# Contributing to Kodi Home Theater +Looking to **contribute code** to Kodi Home Theater? Great! You landed on the right place and we appreciate you for taking the time. Can't code for your life? No shame in that. There's a lot more to the Kodi project than just code. Check out **[other ways](../README.md#how-to-contribute)** to contribute. + +First, a few words of caution: Kodi's huge codebase spans over 15 years of development, hundreds of volunteer developers from all walks of life and countless, sleepless hours. Please remember that somewhere in between your first *WTH?* and before you start ranting or splitting hairs. + +Also, always keep in mind that for many of us English is not our native language. What might come across as discourteous is probably an unintended side effect of the language barrier. Usage of emoticons is highly encouraged. They are great to convey, er, emotions and state of mind. + +## Getting Started +Before you start coding we advise you to build Kodi's master branch. This will save you and us precious time by making sure a proper build environment is set up and all dependencies are met. For your convenience, **[build guides](README.md)** are available for most common platforms. A **[git guide](GIT-FU.md)** is also available, streamlined to Kodi's development workflow. Unless you're a *git ninja*, please read it carefully. +If you are a *git ninja*, we feel happy and sad for you at the same time. Your soul might be lost to the dark side already but worry not, we have cookies! + +## Reviews +Reviews are a great way to get familiar with the codebase. If you would like to start with reviewing just use **[this handy github filter](https://github.com/xbmc/xbmc/pulls?q=is%3Apr+is%3Aopen+review%3Anone)** to see PRs that are in need of one (we have plenty!). + +## Pull request guidelines +* **Create topic branches**. Never ever open a pull request from your master branch. **Ever!** +* **Code against master branch**. Unless release specific, all Kodi development occurs in the `master` branch. If it needs backporting it can be done after it hits master. +* **One topic branch per change**. Found something that needs fixing but is unrelated to the current work? Create a new topic branch and open another *pull request*. +* **Use a coherent commit history**. Make sure each individual commit in your *pull request* is meaningful and organized in logical chunks. Tidy up and squash commits before submitting. +* **Be descriptive, but concise**. The *pull request* and commits should have a useful title and follow the `[component(s)] Short description...` format. No, `[README.md] Update` is **not** descriptive enough. The *pull request* description should only contain information relevant to the change. +* **Be patient, be kind, rewind**. We're all volunteers with busy lives but usually very responsive in cataloging *pull requests* and pinging the relevant maintainer(s). Sometimes though, things go unnoticed for longer than usual. Probably due to beer deprivation... or lack thereof. Feel free to nudge us if we forget. + +## Coding guidelines +* **Follow our [code guidelines](CODE_GUIDELINES.md)**. New code should follow those guidelines even if existing code doesn't. If you're up to it, improve existing code and submit it in separate commits. +* **Document the code**. You know you're brilliant, but maybe you'd like to understand what you did a year from now. Or, code God forbid, help others... Nope, `// Magic. Do not touch!` does not count as documentation. +* **Separate code from cosmetics**. Don't mix code and unrelated cosmetic changes in the same commit. It's already hard to review code without added noise. Of course, deleting a **few** trailing spaces does not warrant a separate commit. Use your judgement. Also, note that the PR build job expects each individual commit to be formatted according to the [`.clang-format`](https://github.com/xbmc/xbmc/blob/master/.clang-format) rules, so if your change touches existing code that needs reformatting to satisfy the current rules, then those would be considered related cosmetic changes that should be included in the same commit. +* **Test your changes**. Kodi's **[continuous integration system](http://jenkins.kodi.tv/)** builds every PR automatically. Nonetheless, you're expected to test the code on your development platform. + +## Updating your PR +Making a *pull request* adhere to the standards above can be difficult. If the maintainers notice anything that they'd like changed, they'll ask you to edit your *pull request* before it gets merged. **There's no need to open a new *pull request*, just edit the existing one**. If you're not sure how to do that, our **[git guide](GIT-FU.md)** provides a step by step guide. If you're still not sure, ask us for guidance. We're all fairly proficient with *git* and happy to be of assistance. + +<a href="https://github.com/xbmc/xbmc"><img src="https://forthebadge.com/images/badges/made-with-c-plus-plus.svg" height="25"></a> +<a href="https://github.com/xbmc/xbmc"><img src="https://forthebadge.com/images/badges/contains-technical-debt.svg" height="25"></a> + diff --git a/docs/GIT-FU.md b/docs/GIT-FU.md new file mode 100644 index 0000000..1afcbf7 --- /dev/null +++ b/docs/GIT-FU.md @@ -0,0 +1,445 @@ + + + +# Kodi's git-fu reference +This guide is intended as a **simple, non-exhaustive, git reference source**. It will help you get acquainted with command-line `git`, even if you never imagined yourself touching the dreaded beast with a 3m pole (that's 10 feet for those across the pound). + +It is streamlined to Kodi's **[fork and pull](https://help.github.com/articles/about-collaborative-development-models/)** development workflow: create feature branch, write awesome code, open a pull request, get it reviewed by Kodi team members, merge pull request. Loop! + +## Table of Contents +1. **[Introduction](#1-introduction)** +2. **[Document conventions](#2-document-conventions)** +3. **[Prerequisites](#3-prerequisites)** +4. **[Clone Kodi's repo into your machine](#4-clone-kodis-repo-into-your-machine)** +5. **[Working with branches](#5-working-with-branches)** + 5.1. **[Create feature branch](#51-create-feature-branch)** + 5.2. **[Push feature branch to origin](#52-push-feature-branch-to-origin)** + 5.3. **[List branches](#53-list-branches)** + 5.4. **[Switch between branches](#54-switch-between-branches)** + 5.5. **[Backup branch](#55-backup-branch)** + 5.6. **[Check branch status](#56-check-branch-status)** + 5.7. **[Delete branch](#57-delete-branch)** + 5.8. **[Rebase branch](#58-rebase-branch)** +6. **[Syncing branches](#6-syncing-branches)** + 6.1. **[Fetch master branch from upstream and sync local master branch with it](#61-fetch-master-branch-from-upstream-and-sync-local-master-branch-with-it)** + 6.2. **[Fetch feature branch from origin and sync local feature branch with it](#62-fetch-feature-branch-from-origin-and-sync-local-feature-branch-with-it)** + 6.3. **[Push local feature branch to origin and sync remote feature branch with it](#63-push-local-feature-branch-to-origin-and-sync-remote-feature-branch-with-it)** +7. **[Working with commits](#7-working-with-commits)** + 7.1. **[Create commit](#71-create-commit)** + 7.2. **[Amend last commit](#72-amend-last-commit)** + 7.3. **[Rename last commit](#73-rename-last-commit)** + 7.4. **[Delete last commit](#74-delete-last-commit)** + 7.5. **[Fix commit](#75-fix-commit)** + 7.6. **[List commits](#76-list-commits)** + 7.7. **[Cherry-pick commits](#77-cherry-pick-commits)** +8. **[Examples with nice screenies](#8-examples-with-nice-screenies)** + 8.1. **[Rebase branch](#81-rebase-branch)** + 8.2. **[Fix commits](#82-fix-commits)** +9. **[Going pro](#9-going-pro)** + 9.1. **[Fetch an upstream pull request](#91-fetch-an-upstream-pull-request)** + 9.2. **[Fetch a pull request someone submitted to your repository](#92-fetch-a-pull-request-someone-submitted-to-your-repository)** + 9.3. **[Fetch a pull request or commit and apply them to another branch](#93-fetch-a-pull-request-or-commit-and-apply-them-to-another-branch)** +10. **[Other resources](#10-other-resources)** + 10.1. **[Using git alias](#101-using-git-alias)** + +## 1. Introduction +**[git](https://en.wikipedia.org/wiki/Git)** is a distributed version control system, originally written by a brilliant, self-described **[bastard](https://lkml.org/lkml/2000/9/6/65)**. It is not the most easy version control system (VCS for short) to work with but it is very intuitive **once** you understand some concepts. Some of the most important ones are outlined below. + +* **repository**: a place where files and their versioned history live. Also known as **repo**. +* **upstream**: Kodi's **[main repository](https://github.com/xbmc/xbmc)**. It's where everything you code will end up after review and a pull request (PR for short) is merged. +* **master**: the repository's main branch. It is where all the code integration happens. +* **remote**: the remote location of a repository, usually on some central server. Both Kodi's **main repository** and your **personal repository** are remotes. +* **origin**: your **personal repository**. Everything you code will end up in your personal repository after you `push`. You're master and commander. +* **fork**: create an exact copy of a remote repository, at that point in time, in your personal GitHub account. +* **clone**: grab an exact copy of a remote repository, usually from your personal repository, and place it on your local machine. +* **branch**: a magical place where what you code doesn't interfere with anything else. Think of it as an house compartment. You cook in the kitchen, sleep in the bedroom, have fun with friends while watching football in the living room, etc. Unlike house compartments, they are free and you can have as many as you like. +* **commit**: chunk of code you committed to. You think it's the best code you've ever written, decided to hang on to it and maybe rule the world one day. +* **pull request**: a request for someone to review your code and include it in Kodi's main repository. +* **fetch**: grab code from an outside source, usually from the main repository. +* **push**: send code to a remote repository, usually to your personal repository. +* **merge**: merge a feature branch with another branch, usually master branch. + +## 2. Document conventions +This guide assumes you are using `terminal`, also known as `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order. + +This is a comment that provides context: +``` +this is a command // this is an inline comment +this is another command // you should not copy them +and yet another one // to the terminal +``` + +**Example:** Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +Commands that contain strings enclosed in angle brackets denote something you need to change to suit your needs. +``` +git clone -b <branch-name> https://github.com/xbmc/xbmc kodi +``` + +**Example:** Clone Kodi's current Krypton branch: +``` +git clone -b Krypton https://github.com/xbmc/xbmc kodi +``` + +Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example: + +**NOTE:** Linux is user friendly... It's just very particular about who its friends are. +**TIP:** Algorithm is what developers call code they do not want to explain. +**WARNING:** Developers don't change light bulbs. It's a hardware problem. + +**[back to top](#table-of-contents)** | **[back to section top](#2-document-conventions)** + +## 3. Prerequisites +This guide assumes you have a **[GitHub account](https://github.com/join)** and that you already **[forked Kodi's repository](https://github.com/xbmc/xbmc/fork/)** into it. + +It also assumes `git` is installed and an SSH key is **[properly configured](https://help.github.com/articles/connecting-to-github-with-ssh/)**. How to install `git` can be found on our specific OS/distribution **[build guides](README.md)**. + +Configure `git` globally so it knows who you are: +``` +git config --global user.email "<your-email>" +git config --global user.name "<your-username>" +``` + +If you're a Windows user you also need: +``` +git config --global core.autocrlf true +``` + +**[back to top](#table-of-contents)** + +## 4. Clone Kodi's repo into your machine +Your forked Kodi's repository will hold everything you do when developing. For safety, you should push every branch and commit you make during development to your remote repository (your GitHub's Kodi fork). You should also be careful not to push sensitive data, credentials, etc. Once online, always online. + +Clone your personal repository into your machine: +``` +cd $HOME // change to your `home` directory +git clone git@github.com:<github-username>/xbmc.git kodi // clone your fork of Kodi's repo +cd kodi // change to the newly cloned repo directory +git remote add upstream https://github.com/xbmc/xbmc.git // assign Kodi's main repo to a remote +``` + +**TIP:** Windows users should use `cd %userprofile%` instead. + +From this point forward, every command shown assumes you're inside `$HOME/kodi` or `%userprofile%\kodi` if you're a Windows user. To get there, issue: +``` +cd $HOME/kodi // or cd %userprofile%\kodi +``` + +**[back to top](#table-of-contents)** + +## 5. Working with branches +Never ever work on master branch. **Ever!** It will get you and probably us into unnecessary trouble. Always create a feature branch. + +### 5.1. Create feature branch +``` +git checkout master // make sure you're on master branch +git checkout -b <feature-branch> // create feature branch +``` + +### 5.2. Push feature branch to origin +Pushing for the first time: +``` +git push --set-upstream origin <feature-branch> +``` + +Subsequent pushes: +``` +git push origin +``` + +Force pushing: +``` +git push -f origin +``` + +### 5.3. List branches +List local branches: +``` +git branch +``` + +List local and remote branches: +``` +git branch -a +``` + +### 5.4. Switch between branches +``` +git checkout <feature-branch> // switch to feature branch +git checkout master // switch back to master branch +``` + +### 5.5. Backup branch +``` +git checkout <feature-branch> // switch to feature branch (the branch you want to backup) +git checkout -b <feature-branch>-backup // create a new branch based on feature branch +git checkout <feature-branch> // switch back to feature branch +``` + +### 5.6. Check branch status +Shows branch name, status in relation to remote origin branch, unstaged changes, etc: +``` +git status +``` + +### 5.7. Delete branch +Delete local branch: +``` +git checkout master // make sure you're not on feature branch to delete +git branch -D <feature-branch> // delete feature branch +``` + +Delete remote branch: +``` +git push origin -d <feature-branch> +``` + +**WARNING:** Be careful deleting branches. Make sure you don't need them anymore. + +### 5.8. Rebase branch +``` +git checkout <feature-branch> // switch to feature branch in need of rebasing +git fetch upstream // fetch upstream changes +git rebase upstream/master // rebase feature branch on top of upstream master branch +git push -f origin // force push updated feature branch to your personal remote repo +``` + +**NOTE**: If you have a **pull request** open from that feature branch, this will also update it. + +**[back to top](#table-of-contents)** | **[back to section top](#5-working-with-branches)** + +## 6. Syncing branches +Keeping branches up-to-date is an excellent base for successful, stress-free coding. You should always start coding a new feature on top of the latest master branch. If you work on more than one machine, this also ensures your feature branch is always up-to-date with the latest changes. + +### 6.1. Fetch master branch from upstream and sync local master branch with it +If you cloned a while ago, you probably want to sync your local master branch with upstream's master branch. This is specially useful to ensure that your new feature branch is based on the latest code version: +``` +git checkout master // switch to master branch +git fetch upstream // fetch upstream changes +git merge upstream/master // merge upstream changes +git push origin // push updated master branch to your personal remote repo (optional) +``` + +### 6.2. Fetch feature branch from origin and sync local feature branch with it +``` +git checkout <feature-branch> // switch to feature branch +git fetch origin // fetch origin changes +git reset --hard origin/<feature-branch> // reset feature branch +``` + +### 6.3. Push local feature branch to origin and sync remote feature branch with it +``` +git checkout <feature-branch> // switch to feature branch +git push origin // push updated feature branch to your personal remote repo +``` + +**WARNING:** Be **very careful** updating to and from origin. It can cause loss of work, specially if you work on more than one machine. Make sure your remote origin repo **always** holds the most up-to-date version of your code. **No, seriously**. Make a mental rule: *remote origin repo always holds the most up-to-date version of my code!* and **stick to it!** It's almost always possible to recover lost work with `git` but it's hard and unnecessary work if you follow some simple rules. + +**[back to top](#table-of-contents)** | **[back to section top](#6-syncing-branches)** + +## 7. Working with commits +All commit manipulating operations (commit, amend or fix a commit, etc.), start by adding your changes before committing: +``` +git add path/to/file/filename // add single file +git add . // add all files on current directory +git add * // add all files in current directory and subdirectories +``` + +### 7.1. Create commit +``` +git commit -m "<commit-description>" +``` + +### 7.2. Amend last commit +``` +git commit --amend +``` + +### 7.3. Rename last commit +``` +git commit --amend // change commit message in your editor and save +``` + +### 7.4. Delete last commit +Delete last commit but keep all the changes it encompasses: +``` +git reset HEAD~ +``` + +Delete last commit, **including all the changes** it encompasses: +``` +git reset --hard HEAD~ +``` + +### 7.5. Fix commit +``` +git commit --fixup <commit-sha> +``` + +### 7.6. List commits +``` +git log --pretty=oneline --abbrev-commit +``` + +### 7.7. Cherry-pick commits +``` +git checkout <feature-branch> // switch to branch with commit(s) you want to cherry-pick +git log --pretty=oneline --abbrev-commit // list commits. take note of the commit(s) `sha` +git checkout <other-feature-branch> // switch to branch that will receive cherry-picked commit(s) +git cherry-pick <sha> // cherry-pick commit +git cherry-pick <sha> // cherry-pick another commit +git cherry-pick <sha> // you get the point +``` + +**[back to top](#table-of-contents)** | **[back to section top](#7-working-with-commits)** + +## 8. Examples with nice screenies +A picture is worth a thousand words. + +### 8.1. Rebase branch + +Check if branch is clean and has no uncommitted changes: + + +Fetch upstream changes and rebase feature branch on top of upstream master branch: + + +Force push branch to remote origin: + + +**[back to top](#table-of-contents)** | **[back to section top](#8-examples)** | **[back to subsection top](#81-rebase-branch)** + +### 8.2. Fix commits + +Check unstaged changes: + + +Add changes and check again: + + +Print a nice commits log and copy `b2184ab68a`, the `sha` of the commit we want to fix: + + +Commit the changes with `git commit --fixup b2184ab68a` to reference the commit in need of fixing: + + +Check if everything is OK and count how many commits we need to use for an `autosquash` rebase (we need nine commits because commit in need of fixing is the ninth commit, including the `fixup` commit): + + +Due to the nature of the `git rebase -i --autosquash HEAD~9` command (opens editor right away), command doesn't show up on this screenshot. See next screenshot. +How it looks after `git` re-orders commits automagically: + + +**NOTE**: These examples use `nano` as default `git` editor to keep things simple. Press `Ctrl+X` to exit and accept the changes. + +A successful message after rebase with `autosquash`: + + +Finally, force push branch to remote origin: + + +**TIP**: It doesn't matter how many `fixup` commits you have on your feature branch. The only thing that matters is the number of the **first** commit with a `fixup` commit. If you're unsure of how many commits that is, issue `git log --pretty=oneline --abbrev-commit`, count from your **first commit** on the feature branch and use that number instead. In this example, that would be 28, e.g. `git rebase -i --autosquash HEAD~28`. `git` will take care of the rest automagically. + +**[back to top](#table-of-contents)** | **[back to section top](#8-examples)** | **[back to subsection top](#82-fix-commits)** + +## 9. Going pro +Got this far? Congrats! Now it gets fun! + +### 9.1. Fetch an upstream pull request +The ability to test pull requests before merging them is very useful. This is how to do it: +``` +git fetch upstream pull/<pull-request-ID>/head:<branch-name-or-pull-request-ID-or-whatever> +git checkout <branch-name-or-pull-request-ID-or-whatever> +``` + +Build Kodi as usual, following our **[build guides](README.md)**. + +### 9.2. Fetch a pull request someone submitted to your repository +Yes, someone might open a pull request to your repository. Be happy that folks want to work with you. + +Same thing as above except that `upstream` is now `origin`. They are both remote repositories, remember? +``` +git fetch origin pull/<pull-request-ID>/head:<branch-name-or-pull-request-ID-or-whatever> +git checkout <branch-name-or-pull-request-ID-or-whatever> +``` + +**TIP**: Every pull request has an unique ID. For instance, the original pull request for this guide is **[PR14072](https://github.com/xbmc/xbmc/pull/14072)**. Its ID is **14072**. + +If you want to try it, issue: +``` +git fetch upstream pull/14072/head:PR14072 // branch name can be anything +git checkout PR14072 // switch to branch +``` + +and see the original version of this documentation in all its glorious might. + +### 9.3. Fetch a pull request or commit and apply them to another branch +Also very useful is the ability to fetch a complete pull request or a single commit and apply it to your **current** branch, instead of creating a new branch like the method outlined above. + +Similarly to the method above, find the PR you want to fetch, **[PR14072](https://github.com/xbmc/xbmc/pull/14072)** for instance, and append `.patch` to the URL. GitHub will generate a formatted patch and show you the output. Copy that URL and choose your next move below. + +Apply the changes to your branch but do not commit them (changes will be kept unstaged): +``` +curl -L https://patch-diff.githubusercontent.com/raw/xbmc/xbmc/pull/14072.patch | git apply - +``` + +Apply the changes to your branch with the original commit(s) message(s): +``` +curl -L https://patch-diff.githubusercontent.com/raw/xbmc/xbmc/pull/14072.patch | git am - +``` + +The same tricks work for a single commit. Just find a commit you'd like to fetch, **[[README] Kodi's codebase new face](https://github.com/xbmc/xbmc/pull/14072/commits/bb62d22f0d62b20ebc2325f7820a37759839efe0)** for instance, append `.patch` to the URL and follow the instructions above. + +**[back to top](#table-of-contents)** | **[back to section top](#9-going-pro)** + +## 10. Other resources +`git` is an incredibly powerful VCS. It's next to impossible to document everything it can do because it's so versatile, many tasks can be achieved in more than one way, and what works for a developer might not work for another. How one uses it heavily depends on the implemented workflow and, to some extent, personal taste. With that in mind, below are listed some external git resources worth a look with many exotic examples. Some you might only need once in a lifetime. + +* **[git-tips](https://github.com/git-tips/tips)** +* **[git-cheat-sheet](https://github.com/arslanbilal/git-cheat-sheet)** + +### 10.1. Using git alias +Aliases are a great `git` feature. Instead of typing - and remembering - a long and boring command, one can instruct `git` to perform an action with a much shorter command. Hence the name aliases. + +The command to add an alias to `git` is simple: `git config --global --add alias.<alias> <command>`. + +For example, add an alias `st` to `status`: +``` +git config --global --add alias.st status +``` + +Now you can just type `git st` instead of `git status`. Saves you a mammoth four keystrokes. + +Some of my favorite aliases are: + +`slog` instead of `log --pretty=oneline --abbrev-commit`: +``` +git config --global --add alias.slog "log --pretty=oneline --abbrev-commit" +``` + +`ema` instead of `cherry-pick`: +``` +git config --global --add alias.ema cherry-pick +``` + +`lg` instead of `log --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative`: +``` +git config --global --add alias.lg "log --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative" + +``` + +`fix` instead of `commit --fixup`: +``` +git config --global --add alias.fix "commit --fixup" // git fix <commit-sha> +``` + +`fixer` instead of `rebase -i --autosquash`: +``` +git config --global --add alias.fixer "rebase -i --autosquash" // git fixer HEAD~10 will autosquash the last 10 commits +``` + +**[back to top](#table-of-contents)** | **[back to section top](#10-other-resources)** + diff --git a/docs/HOWTO.CleanUpLogic.md b/docs/HOWTO.CleanUpLogic.md new file mode 100644 index 0000000..ff9279f --- /dev/null +++ b/docs/HOWTO.CleanUpLogic.md @@ -0,0 +1,164 @@ + + +# HOW-TO: Clean Up Logic +Guide originally published at **[PR13717](https://github.com/xbmc/xbmc/pull/13717)**. To better understand this document, you should read the original *Pull Request*. + +## Table of Contents +1. **[Why clean logic is important](#1-why-clean-logic-is-important)** +2. **[What bad `if` and ternary (`? :`) statements look like](#2-what-bad-if-and-ternary-statements-look-like)** +3. **[How to clean up OR's](#3-how-to-clean-up-ors)** +4. **[How to clean up AND's](#4-how-to-clean-up-ands)** +5. **[How to clean up ternary (`? :`) statements](#5-how-to-clean-up-ternary-statements)** +6. **[Extra credit: the `switch` statement](#6-extra-credit-the-switch-statement)** +7. **[Choosing AND vs. OR](#7-choosing-and-vs-or)** + +## 1. Why clean logic is important + +It's all about readability. We should strive to write code for people, not computers. `if` statements impact the control flow. We want the control flow to be as easy to read and follow as possible. + +**[back to top](#table-of-contents)** + +## 2. What bad if and ternary statements look like + +Take the **[first commit](https://github.com/xbmc/xbmc/commit/2d85c66~6)**. The previous logic roughly translates to: + +```c++ +if (A || B || (C &&D) || ((E || (F && G)) && (H && I && J && K)) || L) + something(); +``` + +Wow. + +Ternary logic can also be unwieldy. For example, the previous logic in the second commit translates to: + +```c++ +X = (A && !B) ? Y : Z; +``` + +This statement isn't as offensive, but wouldn't it be more readable and maintainable by using a few more lines? + +**[back to top](#table-of-contents)** + +## 3. How to clean up OR's + +Generally, OR's are separated by creating a *sequence* of `if`'s on new lines with the same indentation. An initial flag is set, and the `if` statements are used to flip the flag. We can then use a final `if` that only depends on a single flag. + +For example: + +```c++ +if (A || B) + something() +``` + +becomes: + +```c++ +bool flag = false; + +if (A) + flag = true; +else if (B) + flag = true; + +if (flag) + something(); +``` + +This is demonstrated in the commit **[Improve logic for GUI_MSG_QUEUE_NEXT_ITEM in CApplication::OnMessage()](https://github.com/xbmc/xbmc/commit/2d85c66~2)**. + +**[back to top](#table-of-contents)** + +## 4. How to clean up AND's + +Generally, AND's are separated by creating a *series* of `if`'s by embedding indented blocks. + +For example: + +```c++ +if (A && B) + something() +``` + +becomes: + +```c++ +if (A) +{ + if (B) + something(); +} +``` + +This is demonstrated in the commit **[Improve logic in CAutorun::ExecuteAutorun()](https://github.com/xbmc/xbmc/commit/2d85c66~1)**. + +**[back to top](#table-of-contents)** + +## 5. How to clean up ternary statements + +As the name suggests, ternary statements can be split into three lines. For example, + +```c++ +X = (A && !B) ? Y : Z; +``` + +becomes: + +```c++ +X = Y; +if (!A || B) + X = Z; +``` + +This is demonstrated in the commit **[Improve sleep time logic in CApplication::FrameMove()](https://github.com/xbmc/xbmc/commit/2d85c66~5)**. + +**[back to top](#table-of-contents)** + +## 6. Extra credit: the `switch` statement + +As a bonus, if the logic compares the same value to multiple constants, you can use a `switch` statement for a small performance boost. + +For example (notice how I add a tricky OR at the end): + +```c++ +if (x == A || x == B || x == C || y == D) + something(); +``` + +becomes: + +``` +bool flag = false; + +switch (x) +{ +case A: +case B: +case C: + flag = true; + break; +default: + if (y == D) + flag = true; + break; +} + +if (flag) + something(); +``` + +This is demonstrated in the commit **[Clean up player notification logic in CApplication::OnAction()](https://github.com/xbmc/xbmc/commit/2d85c66~6)**. + +Switch statements use *jump tables*, which can be faster than `if`s in some cases because branching slows down speculative execution. + +**[back to top](#table-of-contents)** + +## 7. Choosing AND vs. OR + +In general, I prefer the flag approach (OR) over the embedding indented blocks approach (AND) because less indentation makes the control flow easier to follow. Boolean algebra can be used to convert AND statements into ORs. + +However, when a bunch of ANDs and ORs are combined, sometimes it makes things more complicated to use a single OR operator. It's really a process of trying different algebraic combinations to get the simplest-to-read control flow. + +The last commit shows how I was given a convoluted condition and played around with boolean algebra until I eventually settled on what I considered most readable, **[Improve logic in CGraphicContext::SetFullScreenVideo()](https://github.com/xbmc/xbmc/commit/2d85c66)**. + +**[back to top](#table-of-contents)** + diff --git a/docs/HOWTO.KillAGlobal.md b/docs/HOWTO.KillAGlobal.md new file mode 100644 index 0000000..a946656 --- /dev/null +++ b/docs/HOWTO.KillAGlobal.md @@ -0,0 +1,167 @@ + + +# HOW-TO: Kill a Global +Guide originally published at **[PR13658](https://github.com/xbmc/xbmc/pull/13658)**. To better understand this document, you should read the original *Pull Request*. + +## Table of Contents +1. **[What is the root issue?](#1-what-is-the-root-issue)** +2. **[Globals? Singletons? What's the difference?](#2-globals-singletons-whats-the-difference)** +3. **[What is the solution?](#3-what-is-the-solution)** +4. **[Step 1: Identify and remove the instance](#4-step-1-identify-and-remove-the-instance)** +5. **[Step 2: Add instance to CServiceManager](#5-step-2-add-instance-to-cservicemanager)** +6. **[Step 3: Move initialization and deinitialization to CServiceManager](#6-step-3-move-initialization-and-deinitialization-to-cservicemanager)** +7. **[Step 4: Replace local dependencies with references](#7-step-4-replace-local-dependencies-with-references)** + 7.1. **[Step 4.1 - Settings](#71-step-41---settings)** + 7.2. **[Step 4.2 - Data Cache Core](#72-step-42---data-cache-core)** +8. **[Step 5: Make service registration local](#8-step-5-make-service-registration-local)** +9. **[Step 6: Const-correctness and static cleanup](#9-step-6-const-correctness-and-static-cleanup)** +10. **[Step 7: Replace external uses with CServiceBroker calls](#10-step-7-replace-external-uses-with-cservicebroker-calls)** +11. **[Step 8: Cleanup](#11-step-8-cleanup)** +12. **[Step 9: Submit your PR](#12-step-9-submit-your-pr)** +13. **[Appendix: Dealing with the human aspect](#13-appendix-dealing-with-the-human-aspect)** + +## 1. What is the root issue? +The root issue is that Kodi has a complicated dependency graph, so the order in which things are initialized/deinitialized is very important. When a class is global, we can't control this order, which is why things break. + +**[back to top](#table-of-contents)** + +## 2. Globals? Singletons? What's the difference? +A global is a variable not owned by a class, e.g. + +```c++ +CApplication g_application; +``` + +A singleton is a static variable owned by a class, e.g. + +```c++ +CStereoscopicsManager& CStereoscopicsManager::GetInstance() +{ + static CStereoscopicsManager sStereoscopicsManager; + return sStereoscopicsManager; +} +``` + +With singletons, the constructor is called on first access, so as long as things are accessed in order, Kodi doesn't crash on startup. + +However, on shutdown, singletons are effectively globals, because we don't control the order of destruction. Therefore, I sometimes refer to singletons as globals. + +**[back to top](#table-of-contents)** + +## 3. What is the solution? + +Fernet has implemented a useful architectural tool for removing globals from our codebase. See **[PR13657](https://github.com/xbmc/xbmc/pull/13657)** for an overview of this system. + +**[back to top](#table-of-contents)** + +## 4. Step 1: Identify and remove the instance + +Identify if the service is instantiated as a global or singleton. Remove this instance: **[Remove CStereoscopicsManager instance](https://github.com/garbear/xbmc/commit/35dc0e9~11)**. +Singletons usually have private constructors. Make all constructors public. + +**[back to top](#table-of-contents)** + +## 5. Step 2: Add instance to CServiceManager + +First, identify if lines of code are listed in alphabetical or chronological order. Add the instance and try to match the ordering. In this case, services in CServiceManager are roughly in chronological order: **[Add CStereoscopicsManager instance to CServiceManager](https://github.com/garbear/xbmc/commit/35dc0e9~10)**. + +**[back to top](#table-of-contents)** + +## 6. Step 3: Move initialization and deinitialization to CServiceManager + +This part is tricky. Identify the closest stage where the instance is initialized and move it to CServiceManager: **[Move CStereoscopicsManager init/deinit to CServiceManager](https://github.com/garbear/xbmc/commit/35dc0e9~9)**. + +In this case, it was pretty easy. Init occurred right before Stage 3, so we move it into CServiceManager at the top of Stage 3. + +Notice how deinit is done at the same relative place in the opposite order. + +Before, CStereoscopicsManager was never deinitialized, so adding a deinit step in CServiceManager might cause crashes on shutdown. Regardless, we must be strict in CServiceManager, so we'll have to deal with shutdown crashes if any arise. + +**[back to top](#table-of-contents)** + +## 7. Step 4: Replace local dependencies with references + +A dependency is the use of a variable in another part of Kodi. These can be identified by searching StereoscopicsManager.cpp for all globals (starting with `g_`) and external services (starting with `CServiceBroker::`). + +Here is a list of all dependencies in StereoscopicsManager.cpp: + +* `CServiceBroker::GetSettings()` +* `CServiceBroker::GetDataCacheCore()` +* `CServiceBroker::GetRenderSystem()` +* `g_advancedSettings` +* `g_windowManager` +* `g_localizeStrings` +* `g_graphicsContext` +* `g_application` + +We'll ignore the `g_` globals and Render System for now and focus on removing the first two CServiceBroker ones. If you're feeling adventurous, you can recursively kill the globals and singletons you come across. **[PR13443](https://github.com/xbmc/xbmc/pull/13443)** is my record of 4 in a single PR :) + +### 7.1. Step 4.1 - Settings + +Because CStereoscopicsManager now belongs to CServiceManager, we can remove the use of CServiceBroker by passing references to the constructor upon creation. For example, here we replace access to CSettings with a reference that comes from CServiceManager: **[Replace global access to Settings with a reference](https://github.com/garbear/xbmc/commit/35dc0e9~8)**. + +Note that the reference was placed first in the list of private variables. Some helpful comments were added so future authors will know where to add new variables. + +### 7.2. Step 4.2 - Data Cache Core + +Next, we do the same thing with CDataCacheCore. Notice that we place the new reference on the next line so we can scale to handle lots of dependencies with a clean git history: **[Replace global access to Data Cache Core with reference](https://github.com/garbear/xbmc/commit/35dc0e9~7)**. + +**[back to top](#table-of-contents)** + +## 8. Step 5: Make service registration local + +Now we begin removing external access to the service. Move all service registration to the constructor, using the references we just exposed: **[Make service registration local](https://github.com/garbear/xbmc/commit/35dc0e9~6)**. + +**[back to top](#table-of-contents)** + +## 9. Step 6: Const-correctness and static cleanup + +Take this opportunity to fix non-const and non-static functions: + +* **[Make functions const-correct and static](https://github.com/garbear/xbmc/commit/35dc0e9~5)** +* **[Make functions private that are only used internally](https://github.com/garbear/xbmc/commit/35dc0e9~4)** + +Calls to these functions are made throughout the codebase. Because we're touching all these calls, we can take this opportunity to propagate const-correctness and static-correctness through the codebase. + +**[back to top](#table-of-contents)** + +## 10. Step 7: Replace external uses with CServiceBroker calls + +The final step is to grep the codebase and make all the substitutions required: **[Replace uses of singleton with CServiceBroker](https://github.com/garbear/xbmc/commit/35dc0e9~3)**. + +Notice how our const-correctness and static-correctness are extended almost everywhere. + +Congratulations! Global killed. + +**[back to top](#table-of-contents)** + +## 11. Step 8: Cleanup + +Some code in Kodi goes back 17 years, long before our current style guide was in place. If you touch code that doesn't conform to our style, it's courteous to clean up after yourself. + +It's important that all code cleanup is separate from functional changes. Cleanup commits should be grouped together at the very beginning or very end of the PR. They should be marked as such in the commit message. + +I've performed the following cleanup: + +* **[Cleanup: Replace C-style casts with C++ style casts](https://github.com/garbear/xbmc/commit/35dc0e9~2)** +* **[Cleanup: Fix early return](https://github.com/garbear/xbmc/commit/35dc0e9~1)** +* **[Cleanup: Whitespace improvements](https://github.com/garbear/xbmc/commit/35dc0e9)** + +**[back to top](#table-of-contents)** + +## 12. Step 9: Submit your PR + +The commits in your PR should look like this one, except steps 1-7 should be squashed into a single commit. My steps were for demonstration purposes, and compilation breaks until all 7 are committed. Kodi should always compile between commits to aid in bisecting problems. + +**[back to top](#table-of-contents)** + +## 13. Appendix: Dealing with the human aspect + +Most globals were added in a time before our technomancers gifted us with information on what good architecture looks like. This doesn't mean the original authors wrote "crappy" code, just that they did the best with what they were given. + +As a result, globals are pervasive and dependencies are tangled and, in the nightmare cases, circular. It is almost guaranteed that your hard work will break something for someone else. Fortunately, you'll find most devs are understanding of this. + +This can daisy-chain, because a fix for your breakage can cause even more breakage. If you feel any author of downstream breakage gets undue blame, stick up for them as other devs were understanding for you. + +**[back to top](#table-of-contents)** + diff --git a/docs/MANIFESTO.md b/docs/MANIFESTO.md new file mode 100644 index 0000000..1b7dae9 --- /dev/null +++ b/docs/MANIFESTO.md @@ -0,0 +1,36 @@ +Team Kodi Manifesto +=================== + +The Kodi manifesto is Team-Kodi's public declaration of the Kodi project members principles, philosophy and intentions. This manifesto tries to outline the goals we aim and hope to achieve with Kodi and sum up the Kodi project's strategic direction vision for the present and the future. + +In one sentence, the vision of Team-Kodi is to create the best cross-platform media center software there is. + +User-friendliness is next to godlyness +-------------------------------------- + +One major ongoing goal of Team-Kodi has always been to make Kodi and its user interface feel even more intuitive and user-friendly for its end-users, based on the **KISS** (**K**eep **I**t **S**imple, **S**tupid) principle of simplicity. It is our belief that usability is the most important aspect of a media center like Kodi. Many other media center projects make user interface decisions by developers, who often have little experience in user interface design. In contrast, Team-Kodi does its best to listen to Kodi's end-users to learn how Kodi is actually being used and how we can improve the user experience. We also aim to do regular overhauls, improving existing features/functions, and scrapping outdated code and features/functions (as "too much stuff" adds unnecessary complexity and can thus also be a bad thing). Everything should be made as simple as possible, but no simpler. + +Kodi as a whole must... + +* First and foremost be aimed at a large-screen (28" or more) [10-foot user interface](https://kodi.wiki/view/10-foot_user_interface) for the living-room experience. + * Large menus, text/fonts and buttons that is designed to be navigated by a hand-held remote-control. +* Be focused around the main features of playing music, watching movies, recorded television broadcasts, and viewing pictures. + * Kodi may be capable of converging other things but those things should never take over the main focus in the interface. +* Be easy to install, set up and maintain (so that our valuable end-users do not get fed up with it and quit). +* Have an user interface that is simple and intuitive enough so that less tech-savvy people are not intimidated by it. + * Make common usage easy, simple 'Human–Computer Interaction (HCI)', from the viewpoint of an ordinary user. +* Be able to play audio and video files that have been encoded using DivX, XviD, etc. directly out-of-the-box. +* Be able to organize audio and video files in an easy and user-friendly way. +* Use standards and be consistent, (the Music section can for example not use completely different controls from the Video section). +* Perform actions in the GUI with as few 'clicks' as possible. +* Be aimed at an international audience, internationalization and localization by supporting different languages, timezones and other regional differences +* Require little to no non-GUI configuration (and all such non-GUI configuration should be done in just one file: [advancedsettings.xml](https://kodi.wiki/view/Advancedsettings.xml)). +* Be beautiful to look at, after all we hope you will be using it a lot! + +1.2 Team-Kodi members should always strive to + +* **Promote open source** - Kodi is based on the ideas of FOSS (free open source software), licensed under the GPL and builds partly on other open source projects which we do our best to support. The GPL should be respected at all times. All code should be committed to the Kodi project’s [git repo](https://github.com/xbmc/xbmc) before any public binaries are released. +* **Promote the sharing of knowledge and collaboration** - Through the use of information sharing tools and practices Kodi is a collaborative environment. +* **Understand that development is a team effort** - Treating our users as co-developers has proven to be the most effective option for rapid development. Always strive to work as a team at all times. Actively promote discussion on new features and bug fixes, and respect others comments and criticisms with replies in a timely fashion. +* **Apply the Law of Diminishing Return** - The majority of the effort should be invested in implementing features which have the most benefit and widest general usage by the community. +* **Try to make all code, feature, and functions to be platform agnostic** - Kodi is a multi-platform software, thus any single platform specific features should be discussed with other team members before implemented. Major features should be developed in a separate branch or committed in small increments so that other members have the opportunity to review the code and comment on it during development. diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f0578ac --- /dev/null +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,40 @@ +## Description +<!--- Provide a general summary of your change in the Pull Request title above --> +<!--- Describe your change in detail here. --> + +## Motivation and context +<!--- Why is this change required? What problem does it solve? --> +<!--- If it fixes an open issue, please link to the issue here. --> + +## How has this been tested? +<!--- Please describe in detail how you tested your change. --> +<!--- Include details of your testing environment, and the tests you ran to --> +<!--- see how your change affects other areas of the code, etc. --> + +## What is the effect on users? +<!--- Summarize the effect of this change on Kodi end-users. --> +<!--- If the PR does not have a noticeable impact (e.g., if it only changes documentation), --> +<!--- just leave it empty. Put in more detail the bigger the impact is. --> +<!--- This section may be used for automatic creation of release notes. --> + +## Screenshots (if appropriate): + +## Types of change +<!--- What type of change does your code introduce? Put an `x` in all the boxes that apply like this: [X] --> +- [ ] **Bug fix** (non-breaking change which fixes an issue) +- [ ] **Clean up** (non-breaking change which removes non-working, unmaintained functionality) +- [ ] **Improvement** (non-breaking change which improves existing functionality) +- [ ] **New feature** (non-breaking change which adds functionality) +- [ ] **Breaking change** (fix or feature that will cause existing functionality to change) +- [ ] **Cosmetic change** (non-breaking change that doesn't touch code) +- [ ] **None of the above** (please explain below) + +## Checklist: +<!--- Go over all the following points, and put an `X` in all the boxes that apply like this: [X] --> +<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> +- [ ] My code follows the **[Code Guidelines](https://github.com/xbmc/xbmc/blob/master/docs/CODE_GUIDELINES.md)** of this project +- [ ] My change requires a change to the documentation, either Doxygen or wiki +- [ ] I have updated the documentation accordingly +- [ ] I have read the **[Contributing](https://github.com/xbmc/xbmc/blob/master/docs/CONTRIBUTING.md)** document +- [ ] I have added tests to cover my change +- [ ] All new and existing tests passed diff --git a/docs/README.Android.md b/docs/README.Android.md new file mode 100644 index 0000000..ecc0dcb --- /dev/null +++ b/docs/README.Android.md @@ -0,0 +1,381 @@ + + +# Android build guide +This guide has been tested with Ubuntu 16.04 (Xenial) x86_64. It is meant to cross-compile Kodi for Android using **[Kodi's unified depends build system](../tools/depends/README.md)**. Please read it in full before you proceed to familiarize yourself with the build procedure. + +It should work if you're using macOS. If that is the case, read **[macOS specific prerequisites](#35-macos-specific-prerequisites)** first. + +## Table of Contents +1. **[Document conventions](#1-document-conventions)** +2. **[Install the required packages](#2-install-the-required-packages)** +3. **[Prerequisites](#3-prerequisites)** + 3.1. **[Extract Android SDK and NDK](#31-extract-android-sdk-and-ndk)** + 3.2. **[Configure Android SDK](#32-configure-android-sdk)** + 3.3. **[Set up the Android toolchain](#33-set-up-the-android-toolchain)** + 3.4. **[Create a key to sign debug APKs](#34-create-a-key-to-sign-debug-apks)** + 3.5. **[macOS specific prerequisites](#35-macos-specific-prerequisites)** +4. **[Get the source code](#4-get-the-source-code)** +5. **[Build tools and dependencies](#5-build-tools-and-dependencies)** + 5.1. **[Advanced Configure Options](#51-advanced-configure-options)** +6. **[Build binary add-ons](#6-build-binary-add-ons)** +7. **[Build Kodi](#7-build-kodi)** +8. **[Package](#8-package)** +9. **[Install](#9-install)** +10. **[Debugging Kodi](#10-debugging-kodi)** + +## 1. Document conventions +This guide assumes you are using `terminal`, also known as `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order. + +This is a comment that provides context: +``` +this is a command +this is another command +and yet another one +``` + +**Example:** Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +Commands that contain strings enclosed in angle brackets denote something you need to change to suit your needs. +``` +git clone -b <branch-name> https://github.com/xbmc/xbmc kodi +``` + +**Example:** Clone Kodi's current Krypton branch: +``` +git clone -b Krypton https://github.com/xbmc/xbmc kodi +``` + +Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example: + +**NOTE:** Linux is user friendly... It's just very particular about who its friends are. +**TIP:** Algorithm is what developers call code they do not want to explain. +**WARNING:** Developers don't change light bulbs. It's a hardware problem. + +**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)** + +## 2. Install the required packages +Install build dependencies needed to cross-compile Kodi for Android: +``` +sudo apt install autoconf build-essential curl default-jdk gawk git gperf lib32stdc++6 lib32z1 lib32z1-dev libcurl4-openssl-dev unzip zip zlib1g-dev +``` +**NOTE:** If you're running a 32bit Debian/Ubuntu distribution, remove `lib32stdc++6 lib32z1 lib32z1-dev` from the command. +**NOTE:** Gradle 7.0.2+ requires Jave Runtime 11+. Check java version by running `java --version`. If version is < 11, set JAVA_HOME to java 11+ home directory._ + + +**[back to top](#table-of-contents)** + +## 3. Prerequisites +Building Kodi for Android requires Android NDK revision 20b. For the SDK just use the latest available. +Kodi CI/CD platforms currently use r21e for build testing and releases, so we recommend using r21e for the most tested build experience + +* **[Android SDK](https://developer.android.com/studio/index.html)** (Look for `Get just the command line tools`) +* **[Android NDK](https://developer.android.com/ndk/downloads/index.html)** + +### 3.1. Extract Android SDK and NDK +Create needed directories: +``` +mkdir -p $HOME/android-tools/android-sdk-linux +``` + +Extract Android SDK Command line tools: +``` +unzip $HOME/Downloads/commandlinetools-linux-6200805_latest.zip -d $HOME/android-tools/android-sdk-linux/ +``` + +**NOTE:** Since we're using the latest SDK Command line tools available, filename can change over time. Adapt the `unzip` command accordingly. + +Extract Android NDK: +``` +unzip $HOME/Downloads/android-ndk-r21e-linux-x86_64.zip -d $HOME/android-tools +``` + +### 3.2. Configure Android SDK +Before Android SDK can be used, you need to accept the licenses and configure it: +``` +cd $HOME/android-tools/android-sdk-linux/cmdline-tools/bin +./sdkmanager --sdk_root=$(pwd)/../.. --licenses +./sdkmanager --sdk_root=$(pwd)/../.. platform-tools +./sdkmanager --sdk_root=$(pwd)/../.. "platforms;android-33" +./sdkmanager --sdk_root=$(pwd)/../.. "build-tools;30.0.3" +``` + +### 3.3. Create a key to sign debug APKs +All packages must be signed. The following command will generate a self-signed debug key. If the result is a cryptic error, it probably just means a debug key already existed. + +``` +keytool -genkey -keystore ~/.android/debug.keystore -v -alias androiddebugkey -dname "CN=Android Debug,O=Android,C=US" -keypass android -storepass android -keyalg RSA -keysize 2048 -validity 10000 +``` + +### 3.4. macOS specific prerequisites +* **[Java Development Kit 11+ (JDK)](http://www.oracle.com/technetwork/java/javase/downloads/index.html)** installed. +* Normal macOS installations filesystem is case insensitive but compiling for Android requires a case sensitive filesystem. Generate a writeable hdd image and format it with hfs+ (case sensitive) issuing + * `hdiutil create -type UDIF -fs 'Case-sensitive Journaled HFS+' -size 20g -volname android-dev $HOME/android-dev.dmg` +* Whenever you want to compile/develop you need to mount the image + * `open ~/android-dev.dmg` +* Once you have your hdd image with case sensitive hfs+ file system execute all the steps inside of this filesystem. You need to adapt all paths in this guide so that they match your local environment. As an example here is a configure line that demonstrates possible paths: + * `./configure --with-tarballs=/Users/Shared/xbmc-depends/tarballs --host=arm-linux-androideabi --with-sdk-path=/Volumes/android-dev/android/android-sdk-macosx --with-ndk-path=/Volumes/android-dev/android/android-ndk-r21e --prefix=/Volumes/android-dev/android/xbmc-depends` + +**[back to top](#table-of-contents)** | **[back to section top](#3-prerequisites)** + +## 4. Get the source code +Change to your `home` directory: +``` +cd $HOME +``` + +Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +## 5. Build tools and dependencies +Prepare to configure build: +``` +cd $HOME/kodi/tools/depends +./bootstrap +``` + +**TIP:** Look for comments starting with `Or ...` and only execute the command(s) you need. + +Configure build for aarch64: +``` +./configure --with-tarballs=$HOME/android-tools/xbmc-tarballs --host=aarch64-linux-android --with-sdk-path=$HOME/android-tools/android-sdk-linux --with-ndk-path=$HOME/android-tools/android-ndk-r21e --prefix=$HOME/android-tools/xbmc-depends +``` + +Or configure build for arm: +``` +./configure --with-tarballs=$HOME/android-tools/xbmc-tarballs --host=arm-linux-androideabi --with-sdk-path=$HOME/android-tools/android-sdk-linux --with-ndk-path=$HOME/android-tools/android-ndk-r21e --prefix=$HOME/android-tools/xbmc-depends +``` + +Or configure build for x86: +``` +./configure --with-tarballs=$HOME/android-tools/xbmc-tarballs --host=i686-linux-android --with-sdk-path=$HOME/android-tools/android-sdk-linux --with-ndk-path=$HOME/android-tools/android-ndk-r21e --prefix=$HOME/android-tools/xbmc-depends +``` + +Or configure build for x86_64: +``` +./configure --with-tarballs=$HOME/android-tools/xbmc-tarballs --host=x86_64-linux-android --with-sdk-path=$HOME/android-tools/android-sdk-linux --with-ndk-path=$HOME/android-tools/android-ndk-r21e --prefix=$HOME/android-tools/xbmc-depends +``` + +> **Note:** Android x86 and x86_64 are not maintained and are not 100% sure that everything works correctly! + +Build tools and dependencies: +``` +make -j$(getconf _NPROCESSORS_ONLN) +``` + +**TIP:** By adding `-j<number>` to the make command, you can choose how many concurrent jobs will be used and expedite the build process. It is recommended to use `-j$(getconf _NPROCESSORS_ONLN)` to compile on all available processor cores. The build machine can also be configured to do this automatically by adding `export MAKEFLAGS="-j$(getconf _NPROCESSORS_ONLN)"` to your shell config (e.g. `~/.bashrc`). + +**WARNING:** Look for the `Dependencies built successfully.` success message. If in doubt run a single threaded `make` command until the message appears. If the single make fails, clean the specific library by issuing `make -C target/<name_of_failed_lib> distclean` and run `make`again. + +### 5.1. Advanced Configure Options + + +**All platforms:** + +``` +--with-toolchain=<path> +``` + specify path to toolchain. Auto set for android. Defaults to xcode root for darwin, /usr for linux + +``` +--enable-debug=<yes:no> +``` + enable debugging information (default is yes) + +``` +--disable-ccache +``` + disable ccache + +``` +--with-tarballs=<path> +``` + path where tarballs will be saved [prefix/xbmc-tarballs] + +``` +--with-cpu=<cpu> +``` + optional. specify target cpu. guessed if not specified + +``` +--with-linker=<linker> +``` + specify linker to use. (default is ld) + +``` +--with-platform=<platform> +``` + target platform + +``` +--enable-gplv3=<yes:no> +``` + enable gplv3 components. (default is yes) + +``` +--with-target-cflags=<cflags> +``` + C compiler flags (target) + +``` +--with-target-cxxflags=<cxxflags> +``` + C++ compiler flags (target) + +``` +--with-target-ldflags=<ldflags> +``` + linker flags. Use e.g. for -l<lib> (target) + +``` +--with-ffmpeg-options +``` + FFmpeg configure options, e.g. --enable-vaapi (target) + + +**Android Specific:** + +``` +--with-ndk-api=<ndk number> +``` + specify ndk level (optional for android), default is 21.] + +``` +--with-ndk-path=<path> +``` + specify path to ndk (required for android only) + +``` +--with-sdk-path=<path> +``` + specify path to sdk (required for android only) + + +**[back to top](#table-of-contents)** | **[back to section top](#5-build-tools-and-dependencies)** + +## 6. Build binary add-ons +You can find a complete list of available binary add-ons **[here](https://github.com/xbmc/repo-binary-addons)**. + +Change to Kodi's source code directory: +``` +cd $HOME/kodi +``` + +Build all add-ons: +``` +make -j$(getconf _NPROCESSORS_ONLN) -C tools/depends/target/binary-addons +``` + +Build specific add-ons: +``` +make -j$(getconf _NPROCESSORS_ONLN) -C tools/depends/target/binary-addons ADDONS="audioencoder.flac pvr.vdr.vnsi audiodecoder.snesapu" +``` + +Build a specific group of add-ons: +``` +make -j$(getconf _NPROCESSORS_ONLN) -C tools/depends/target/binary-addons ADDONS="pvr.*" +``` +For additional information on regular expression usage for ADDONS_TO_BUILD, view ADDONS_TO_BUILD section located at [Kodi add-ons CMake based buildsystem](../cmake/addons/README.md) + +**[back to top](#table-of-contents)** + +## 7. Build Kodi +Configure CMake build: +``` +cd $HOME/kodi +make -C tools/depends/target/cmakebuildsys +``` + +**TIP:** BUILD_DIR can be provided as an argument to cmakebuildsys. This allows you to provide an alternate build location. Change all paths onwards as required if BUILD_DIR option used. +``` +mkdir $HOME/kodi-build +make -C tools/depends/target/cmakebuildsys BUILD_DIR=$HOME/kodi-build +``` + +Build Kodi: +``` +cd $HOME/kodi-build +make -j$(getconf _NPROCESSORS_ONLN) +``` + +**[back to top](#table-of-contents)** + +## 8. Package +CMake generates a target called `apk` which will package Kodi ready for distribution. + +Create package: +``` +make apk +``` + +Generated `apk` file will be inside `$HOME/kodi`. + +**[back to top](#table-of-contents)** + +## 9. Install +Connect your Android device to your computer through USB and enable the `Unknown sources` option in your device settings. + +Make sure `adb` is installed: +``` +sudo apt install adb +``` + +Install Kodi: +``` +cd $HOME/kodi-android +adb devices +adb -s <device-id> install -r <generated-apk-name-here>.apk +``` + +The *device-id* can be retrieved from the list returned by the `adb devices` command and is the first value in the row representing your device. + +**[back to top](#table-of-contents)** + +## 10. Debugging Kodi +To be able to see what is happening while running Kodi you need to enable `USB debugging` in your device settings (already enabled in the Android Emulator). + +Access the log output of your Android device: +``` +adb -s <device-id> logcat +``` + +Install a new build over the existing one: +``` +adb -e install -r images/xbmcapp-debug.apk +``` + +Launch Kodi on Android Emulator without the GUI: +``` +adb shell am start -a android.intent.action.MAIN -n org.xbmc.xbmc/android.app.NativeActivity +``` + +Kill a misbehaving Kodi: +``` +adb shell ps | grep org.xbmc | awk '{print $2}' | xargs adb shell kill +``` + +Filter logcat messages by a specific tag (e.g. `Kodi`): +``` +adb logcat -s Kodi:V +``` + +Enable CheckJNI (**before** starting the Kodi): +``` +adb shell setprop debug.checkjni 1 +``` + +**NOTE:** These commands assume that current directory is `$HOME/kodi-build/tools/android/packaging` and that the proper SDK/NDK paths are set. + +GDB can be used to debug, though the support is rather primitive. Rather than using `gdb` directly, you will need to use `ndk-gdb` which wraps it. You can use the `-p/--project` switches or instead you will need to `cd` to `$HOME/kodi-build/tools/android/packaging/xbmc` and execute it from there. +``` + ndk-gdb --verbose +``` + +This will open the installed version of Kodi and break. The warnings can be ignored as we have the appropriate paths already setup. + +**[back to top](#table-of-contents)** | **[back to section top](#10-debugging-kodi)** + diff --git a/docs/README.Fedora.md b/docs/README.Fedora.md new file mode 100644 index 0000000..a58c290 --- /dev/null +++ b/docs/README.Fedora.md @@ -0,0 +1,106 @@ + + +# Fedora build guide +This guide has been tested with Fedora 36 1.1 x86_64. Please read it in full before you proceed to familiarize yourself with the build procedure. + +Several other distributions have **[specific build guides](README.md)** and a general **[Linux build guide](README.Linux.md)** is also available. + +## Table of Contents +1. **[Document conventions](#1-document-conventions)** +2. **[Get the source code](#2-get-the-source-code)** +3. **[Install the required packages](#3-install-the-required-packages)** +4. **[Build Kodi](#4-build-kodi)** + +## 1. Document conventions +This guide assumes you are using `terminal`, also known as `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order. + +This is a comment that provides context: +``` +this is a command +this is another command +and yet another one +``` + +**Example:** Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +Commands that contain strings enclosed in angle brackets denote something you need to change to suit your needs. +``` +git clone -b <branch-name> https://github.com/xbmc/xbmc kodi +``` + +**Example:** Clone Kodi's current Krypton branch: +``` +git clone -b Krypton https://github.com/xbmc/xbmc kodi +``` + +Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example: + +**NOTE:** Linux is user friendly... It's just very particular about who its friends are. +**TIP:** Algorithm is what developers call code they do not want to explain. +**WARNING:** Developers don't change light bulbs. It's a hardware problem. + +**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)** + +## 2. Get the source code +Make sure `git` is installed: +``` +sudo dnf install git +``` + +Clone Kodi's current master branch: +``` +cd $HOME +git clone https://github.com/xbmc/xbmc kodi +``` + +**[back to top](#table-of-contents)** + +## 3. Install the required packages +If you get a `package not found` type of message with the below command, remove the offending package(s) from the install list and reissue the command. Take a note of the missing dependencies and, after a successful step completion, **[build the missing dependencies manually](README.Linux.md#31-build-missing-dependencies)**. + +**NOTE:** Kodi requires a compiler with C++17 support, i.e. gcc >= 7 or clang >= 5 + +Install build dependencies: +``` +sudo dnf install alsa-lib-devel autoconf automake avahi-compat-libdns_sd-devel avahi-devel bluez-libs-devel bzip2-devel cmake curl dbus-devel flatbuffers flatbuffers-devel fmt-devel fontconfig-devel freetype-devel fribidi-devel fstrcmp-devel gawk gcc gcc-c++ gettext gettext-devel giflib-devel gperf gtest-devel java-11-openjdk-headless jre lcms2-devel libao-devel libass-devel libbluray-devel libcap-devel libcdio-devel libcec-devel libcurl-devel libidn2-devel libjpeg-turbo-devel libmicrohttpd-devel libmpc-devel libnfs-devel libplist-devel libpng12-devel libsmbclient-devel libtool libtool-ltdl-devel libudev-devel libunistring libunistring-devel libusb-devel libuuid-devel libva-devel libvdpau-devel libxkbcommon-devel libxml2-devel libXmu-devel libXrandr-devel libxslt-devel libXt-devel lirc-devel lzo-devel make mariadb-devel mesa-libEGL-devel mesa-libGL-devel mesa-libGLU-devel mesa-libGLw-devel mesa-libOSMesa-devel nasm openssl-devel openssl-libs patch pcre-devel pulseaudio-libs-devel python3-devel python3-pillow rapidjson-devel shairplay-devel spdlog-devel sqlite-devel swig taglib-devel tinyxml-devel trousers-devel uuid-devel zlib-devel +``` + +**WARNING:** Make sure you copy paste the entire line or you might receive an error or miss a few dependencies. + +Building for Wayland requires some extra packages: +``` +sudo dnf install mesa-libGLES-devel wayland-devel waylandpp-devel wayland-protocols-devel +``` + +Similarly, building for GBM also requires some extra packages: +``` +sudo dnf install libinput-devel libxkbcommon-devel mesa-libGLES-devel mesa-libgbm-devel +``` + +Optional packages that you might want to install for extra functionality (generating doxygen documentation, for instance): +``` +sudo dnf install doxygen mariadb-devel +``` + +**NOTE:** For developers and anyone else who builds frequently it is recommended to install `ccache` to expedite subsequent builds of Kodi. + +You can install it with: +``` +sudo dnf install ccache +``` + +**TIP:** If you have multiple computers at home, `distcc` will distribute build workloads of C and C++ code across several machines on a network. Team Kodi may not be willing to give support if problems arise using such a build configuration. + +You can install it with: +``` +sudo dnf install distcc +``` + +## 4. Build Kodi +See the general **[Linux build guide](README.Linux.md)** for reference. + +**[back to top](#table-of-contents)** + diff --git a/docs/README.FreeBSD.md b/docs/README.FreeBSD.md new file mode 100644 index 0000000..8424cc1 --- /dev/null +++ b/docs/README.FreeBSD.md @@ -0,0 +1,241 @@ + + +# FreeBSD build guide +This guide has been tested with FreeBSD 12.1 x86_64. Please read it in full before you proceed to familiarize yourself with the build procedure. + +Several other distributions have **[specific build guides](README.md)** and a general **[Linux build guide](README.Linux.md)** is also available. + +## Table of Contents +1. **[Document conventions](#1-document-conventions)** +2. **[Get the source code](#2-get-the-source-code)** +3. **[Install the required packages](#3-install-the-required-packages)** + 3.1. **[Build missing dependencies](#31-build-missing-dependencies)** +4. **[Build Kodi](#4-build-kodi)** + 4.1. **[Configure build](#41-configure-build)** + 4.2. **[Build](#42-build)** +5. **[Build binary add-ons](#5-build-binary-add-ons)** +6. **[Run Kodi](#6-run-kodi)** +7. **[Uninstall Kodi](#7-uninstall-kodi)** +8. **[Test suite](#8-test-suite)** + +## 1. Document conventions +This guide assumes you are using `terminal`, also known as `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order. + +This is a comment that provides context: +``` +this is a command +this is another command +and yet another one +``` + +**Example:** Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +Commands that contain strings enclosed in angle brackets denote something you need to change to suit your needs. +``` +git clone -b <branch-name> https://github.com/xbmc/xbmc kodi +``` + +**Example:** Clone Kodi's current Krypton branch: +``` +git clone -b Krypton https://github.com/xbmc/xbmc kodi +``` + +Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example: + +**NOTE:** Linux is user friendly... It's just very particular about who its friends are. +**TIP:** Algorithm is what developers call code they do not want to explain. +**WARNING:** Developers don't change light bulbs. It's a hardware problem. + +**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)** + +## 2. Get the source code +Make sure `git` is installed: +``` +sudo pkg install git +``` + +Change to your `home` directory: +``` +cd $HOME +``` + +Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +**[back to top](#table-of-contents)** + +## 3. Install the required packages +If you get a `package not found` type of message with the below command, remove the offending package(s) from the install list and reissue the command. Take a note of the missing dependencies and, after a successful step completion, **[build the missing dependencies manually](#31-build-missing-dependencies)**. + +**NOTE:** Kodi requires a compiler with C++17 support, i.e. gcc >= 7 or clang >= 5 + +Install build dependencies: +``` +sudo pkg install autoconf automake avahi-app binutils cmake curl dbus doxygen e2fsprogs-libuuid enca encodings flac flatbuffers font-util fontconfig freetype2 fribidi fstrcmp gawk gettext-tools giflib git glew gmake gmp gnutls googletest gperf gstreamer1-vaapi hal jpeg-turbo libaacs libass libbdplus libbluray libcapn libcdio libcec libedit libfmt libgcrypt libgpg-error libidn libinotify libmicrohttpd libnfs libogg libplist librtmp libtool libudev-devd libva libvdpau libvorbis libxslt lirc lzo2 m4 mesa-libs mysql57-client nasm openjdk8 p8-platform pkgconf python3 rapidjson shairplay sndio sqlite3 swig30 taglib tiff tinyxml xf86-input-keyboard xf86-input-mouse xorg-server xrandr zip +``` + +**WARNING:** Make sure you copy paste the entire line or you might receive an error or miss a few dependencies. + +**NOTE:** For developers and anyone else who builds frequently it is recommended to install `ccache` to expedite subsequent builds of Kodi. + +You can install it with: +``` +sudo pkg install ccache +``` + +**TIP:** If you have multiple computers at home, `distcc` will distribute build workloads of C and C++ code across several machines on a network. Team Kodi may not be willing to give support if problems arise using such a build configuration. + +You can install it with: +``` +sudo pkg install distcc +``` + +### 3.1. Build missing dependencies +See the general **[Linux build guide](README.Linux.md)** for reference. + +**[back to top](#table-of-contents)** | **[back to section top](#3-install-the-required-packages)** + +## 4. Build Kodi +### 4.1. Configure build +If you get a `Could NOT find...` error message during CMake configuration step, take a note of the missing dependencies and either install them from repositories (if available) or **[build the missing dependencies manually](#31-build-missing-dependencies)**. + +Create an out-of-source build directory: +``` +mkdir $HOME/kodi-build +``` + +Change to build directory: +``` +cd $HOME/kodi-build +``` + +Configure build: +``` +cmake ../kodi -DCMAKE_INSTALL_PREFIX=/usr/local +``` + +### 4.2. Build +``` +cmake --build . -- VERBOSE=1 -j$(sysctl hw.ncpu | awk '{print $2}') +``` +**TIP:** By adding `-j<number>` to the make command, you can choose how many concurrent jobs will be used and expedite the build process. It is recommended to use `-j$(sysctl hw.ncpu | awk '{print $2}')` to compile on all available processor cores. + +After the build process completes successfully you can test your shiny new Kodi build while in the build directory: +``` +./kodi-x11 +``` + +If everything was OK during your test you can now install the binaries to their place, in this example */usr/local*. +``` +sudo gmake install +``` + +**NOTE:** `gmake` stands for *GNU Make*. BSD's own make does not work here. + +This will install Kodi in the prefix provided in **[section 4.1](#41-configure-build)**. + +**TIP:** To override Kodi's install location, use `DESTDIR=<path>`. For example: +``` +sudo gmake install DESTDIR=$HOME/kodi +``` + +**[back to top](#table-of-contents)** | **[back to section top](#4-build-kodi)** + +## 5. Build binary add-ons +You can find a complete list of available binary add-ons **[here](https://github.com/xbmc/repo-binary-addons)**. + +Change to Kodi's source code directory: +``` +cd $HOME/kodi +``` + +Build all add-ons: +``` +sudo gmake -j$(sysctl hw.ncpu | awk '{print $2}') -C tools/depends/target/binary-addons PREFIX=/usr/local +``` + +Build specific add-ons: +``` +sudo gmake -j$(sysctl hw.ncpu | awk '{print $2}') -C tools/depends/target/binary-addons PREFIX=/usr/local ADDONS="audioencoder.flac pvr.vdr.vnsi audiodecoder.snesapu" +``` + +Build a specific group of add-ons: +``` +sudo gmake -j$(sysctl hw.ncpu | awk '{print $2}') -C tools/depends/target/binary-addons PREFIX=/usr/local ADDONS="pvr.*" +``` +For additional information on regular expression usage for ADDONS_TO_BUILD, view ADDONS_TO_BUILD section located at [Kodi add-ons CMake based buildsystem](../cmake/addons/README.md) + +**NOTE:** `PREFIX=/usr/local` should match Kodi's `-DCMAKE_INSTALL_PREFIX=` prefix used in **[section 4.1](#41-configure-build)**. + +**[back to top](#table-of-contents)** + +## 6. Run Kodi +If you chose to install Kodi using `/usr` or `/usr/local` as the `-DCMAKE_INSTALL_PREFIX=`, you can just issue *kodi* in a terminal session. + +If you changed `-DCMAKE_INSTALL_PREFIX=` to install Kodi into some non-standard location, you will have to run Kodi directly: +``` +<CMAKE_INSTALL_PREFIX>/bin/kodi +``` + +To run Kodi in *portable* mode (useful for testing): +``` +<CMAKE_INSTALL_PREFIX>/bin/kodi -p +``` + +**[back to top](#table-of-contents)** + +## 7. Uninstall Kodi +``` +sudo gmake uninstall +``` +**WARNING:**: If you reran CMakes' configure step with a different `-DCMAKE_INSTALL_PREFIX=`, you will need to rerun configure with the correct path for this step to work correctly. + +If you would like to also remove any settings and third-party addons (skins, scripts, etc.) and Kodi configuration files, you should also run: +``` +rm -rf ~/.kodi +``` + +**[back to top](#table-of-contents)** + +## 8. Test suite +Kodi has a test suite which uses the Google C++ Testing Framework. This framework is provided directly in Kodi's source tree. + +Build and run Kodi's test suite: +``` +gmake check +``` + +Build Kodi's test suite without running it: +``` +gmake kodi-test +``` + +Run Kodi's test suite manually: +``` +./kodi-test +``` + +Show Kodi's test suite *help* notes: +``` +./kodi-test --gtest_help +``` + +Useful options: +``` +--gtest_list_tests + List the names of all tests instead of running them. + The name of TEST(Foo, Bar) is "Foo.Bar". + +--gtest_filter=POSITIVE_PATTERNS[-NEGATIVE_PATTERNS] + Run only the tests whose name matches one of the positive patterns but + none of the negative patterns. '?' matches any single character; '*' + matches any substring; ':' separates two patterns. +``` + +**[back to top](#table-of-contents)** + diff --git a/docs/README.Linux.md b/docs/README.Linux.md new file mode 100644 index 0000000..01ae57c --- /dev/null +++ b/docs/README.Linux.md @@ -0,0 +1,373 @@ + + +# Linux build guide +This is the general Linux build guide. Please read it in full before you proceed to familiarize yourself with the build procedure. + +Several distribution **[specific build guides](README.md)** are available. + +## Table of Contents +1. **[Document conventions](#1-document-conventions)** +2. **[Get the source code](#2-get-the-source-code)** +3. **[Install the required packages](#3-install-the-required-packages)** + 3.1. **[Build missing dependencies](#31-build-missing-dependencies)** + 3.2. **[Enable internal dependencies](#32-enable-internal-dependencies)** +4. **[Build Kodi](#4-build-kodi)** + 4.1. **[Configure build](#41-configure-build)** + 4.2. **[Build](#42-build)** +5. **[Build binary add-ons](#5-build-binary-add-ons)** + 5.1. **[In-tree building of binary add-ons](#51-in-tree-building-of-binary-add-ons)** + 5.2. **[Out-of-tree building of binary add-ons](#52-out-of-tree-building-of-binary-add-ons)** +6. **[Run Kodi](#6-run-kodi)** +7. **[Uninstall Kodi](#7-uninstall-kodi)** +8. **[Test suite](#8-test-suite)** + +## 1. Document conventions +This guide assumes you are using `terminal`, also known as `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order. + +This is a comment that provides context: +``` +this is a command +this is another command +and yet another one +``` + +**Example:** Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +Commands that contain strings enclosed in angle brackets denote something you need to change to suit your needs. +``` +git clone -b <branch-name> https://github.com/xbmc/xbmc kodi +``` + +**Example:** Clone Kodi's current Krypton branch: +``` +git clone -b Krypton https://github.com/xbmc/xbmc kodi +``` + +Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example: + +**NOTE:** Linux is user friendly... It's just very particular about who its friends are. +**TIP:** Algorithm is what developers call code they do not want to explain. +**WARNING:** Developers don't change light bulbs. It's a hardware problem. + +**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)** + +## 2. Get the source code +First install the `git` package provided by your distribution. How to do it can be found with a quick search in your favorite search engine. + +Change to your `home` directory: +``` +cd $HOME +``` + +Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +**[back to top](#table-of-contents)** + +## 3. Install the required packages +The following is the list of packages that are used to build Kodi on Debian/Ubuntu (with all supported external libraries enabled). + +**NOTE:** Kodi requires a compiler with C++17 support, i.e. gcc >= 7 or clang >= 5 + +* autoconf, automake, autopoint, gettext, autotools-dev, cmake, curl, default-jre | openjdk-6-jre | openjdk-7-jre, gawk, gcc (>= 7) | gcc-7, g++ (>= 7) | g++-7, cpp (>= 7) | cpp-7, flatbuffers, gdc, gperf, libasound2-dev | libasound-dev, libass-dev (>= 0.9.8), libavahi-client-dev, libavahi-common-dev, libbluetooth-dev, libbluray-dev, libbz2-dev, libcdio-dev, libcec4-dev | libcec-dev, libp8-platform-dev, libcrossguid-dev, libcurl4-openssl-dev | libcurl4-gnutls-dev | libcurl-dev, libcwiid-dev, libdbus-1-dev, libegl1-mesa-dev, libenca-dev, libflac-dev, libfontconfig-dev, libfmt3-dev | libfmt-dev, libfreetype6-dev, libfribidi-dev, libfstrcmp-dev, libgcrypt-dev, libgif-dev (>= 5.0.5), libgles2-mesa-dev [armel] | libgl1-mesa-dev | libgl-dev, libglew-dev, libglu1-mesa-dev | libglu-dev, libgnutls-dev | libgnutls28-dev, libgpg-error-dev, libgtest-dev, libiso9660-dev, libjpeg-dev, liblcms2-dev, liblirc-dev, libltdl-dev, liblzo2-dev, libmicrohttpd-dev, libmysqlclient-dev, libnfs-dev, libogg-dev, libomxil-bellagio-dev [armel], libpcre3-dev, libplist-dev, libpng12-dev | libpng-dev, libpulse-dev, libshairplay-dev, libsmbclient-dev, libspdlog-dev, libsqlite3-dev, libssl-dev, libtag1-dev (>= 1.8) | libtag1x8, libtiff5-dev | libtiff-dev | libtiff4-dev, libtinyxml-dev, libtool, libudev-dev, libunistring-dev, libva-dev, libvdpau-dev, libvorbis-dev, libxkbcommon-dev, libxmu-dev, libxrandr-dev, libxslt1-dev | libxslt-dev, libxt-dev, waylandpp-dev | netcat, wayland-protocols | wipe, lsb-release, meson (>= 0.47.0), nasm (>= 2.14), ninja-build, python3-dev, python3-pil | python-imaging, python-support | python3-minimal, rapidjson-dev, swig, unzip, uuid-dev, zip, zlib1g-dev + +### 3.1. Build missing dependencies +Some packages may be missing or outdated in older distributions. Notably `crossguid`, `libfmt`, `libspdlog`, `waylandpp`, `wayland-protocols`, etc. are known to be outdated or missing. Fortunately there is an easy way to build individual dependencies with **[Kodi's unified depends build system](../tools/depends/README.md)**. + +Change to Kodi's source code directory: +``` +cd $HOME/kodi +``` + +Build and install crossguid: +``` +sudo make -C tools/depends/target/crossguid PREFIX=/usr/local +``` + +Build and install flatbuffers: +``` +sudo make -C tools/depends/target/flatbuffers PREFIX=/usr/local +``` + +Build and install libfmt: +``` +sudo make -C tools/depends/target/fmt PREFIX=/usr/local +``` + +Build and install libspdlog: +``` +sudo make -C tools/depends/target/spdlog PREFIX=/usr/local +``` + +Build and install wayland-protocols: +``` +sudo make -C tools/depends/target/wayland-protocols PREFIX=/usr/local +``` + +Build and install waylandpp: +``` +sudo make -C tools/depends/target/waylandpp PREFIX=/usr/local +``` + +**WARNING:** Building `waylandpp` has some dependencies of its own, namely `scons, libwayland-dev (>= 1.11.0) and libwayland-egl1-mesa` + +**TIP:** Complete list of dependencies is available **[here](https://github.com/xbmc/xbmc/tree/master/tools/depends/target)**. + +### 3.2. Enable internal dependencies +Some dependencies can be configured to build before Kodi. That's the case with `flatbuffers`, `crossguid`, `fmt`, `spdlog`, `rapidjson`, `fstrcmp` and `dav1d`. To enable the internal build of a dependency, append `-DENABLE_INTERNAL_<DEPENDENCY_NAME>=ON` to the configure command below. For example, configuring an X11 build with internal `fmt` would become `cmake ../kodi -DCMAKE_INSTALL_PREFIX=/usr/local -DENABLE_INTERNAL_FMT=ON` instead of `cmake ../kodi -DCMAKE_INSTALL_PREFIX=/usr/local`. +Internal dependencies that are based on cmake upstream (currently crossguid, ffmpeg, fmt, spdlog) can have their build type overridden by defining `-D<DEPENDENCY_NAME>_BUILD_TYPE=<buildtype>`. Build Type can be one of `Release, RelWithDebInfo, Debug, MinSizeRel`. eg `-DFFMPEG_BUILD_TYPE=RelWithDebInfo`. If not provided, the build type will be the same as the core Kodi project. + +**Note:** fstrcmp requires libtool + +**[back to top](#table-of-contents)** | **[back to section top](#3-installing-the-required-packages)** + +## 4. Build Kodi +### 4.1. Configure build +If you get a `Could NOT find...` error message during CMake configuration step, take a note of the missing dependencies and either install them from repositories (if available) or **[build the missing dependencies manually](#31-build-missing-dependencies)**. + +Create an out-of-source build directory: +``` +mkdir $HOME/kodi-build +``` + +**TIP:** Look for comments starting with `Or ...` and only execute the command(s) you need. + +Change to build directory: +``` +cd $HOME/kodi-build +``` + +Configure build for X11: +``` +cmake ../kodi -DCMAKE_INSTALL_PREFIX=/usr/local -DCORE_PLATFORM_NAME=x11 -DAPP_RENDER_SYSTEM=gl +``` + +**NOTE:** You can use `gles` instead of `gl` if you want to build with `GLES`. + +Or configure build for Wayland: +``` +cmake ../kodi -DCMAKE_INSTALL_PREFIX=/usr/local -DCORE_PLATFORM_NAME=wayland -DAPP_RENDER_SYSTEM=gl +``` + +**NOTE:** You can use `gles` instead of `gl` if you want to build with `GLES`. + +Or configure build for GBM: +``` +cmake ../kodi -DCMAKE_INSTALL_PREFIX=/usr/local -DCORE_PLATFORM_NAME=gbm -DAPP_RENDER_SYSTEM=gles +``` + +**NOTE:** You can use `gl` instead of `gles` if you want to build with `GL`. + +Or configure build with any combination of the three (default is "x11 wayland gbm"): +``` +cmake ../kodi -DCMAKE_INSTALL_PREFIX=/usr/local -DCORE_PLATFORM_NAME="x11 wayland gbm" -DAPP_RENDER_SYSTEM=gl +``` + +**NOTE:** You can use `gles` instead of `gl` if you want to build with `GLES`. + + +**NOTE:** You can use several alternative linkers if available on your system: gnu gold (default), llvm lld or mold + +To use an alternative linker, enable it with `-DENABLE_GOLD=ON` or `-DENABLE_LLD=ON` or `-DENABLE_MOLD=ON` + + +### 4.2. Build +``` +cmake --build . -- VERBOSE=1 -j$(getconf _NPROCESSORS_ONLN) +``` +**TIP:** By adding `-j<number>` to the make command, you can choose how many concurrent jobs will be used and expedite the build process. It is recommended to use `-j$(getconf _NPROCESSORS_ONLN)` to compile on all available processor cores. The build machine can also be configured to do this automatically by adding `export MAKEFLAGS="-j$(getconf _NPROCESSORS_ONLN)"` to your shell config (e.g. `~/.bashrc`). + +After the build process completes successfully you can test your shiny new Kodi build while in the build directory: +``` +./kodi-x11 +``` + +Or if you built for Wayland: +``` +./kodi-wayland +``` + +Or if you built for GBM: +``` +./kodi-gbm +``` + +**WARNING:** User running `kodi-gbm` needs to be part of `input` and `video` groups. Otherwise you'll have to use `sudo`. + +Add user to input and video groups: +``` +sudo usermod -a -G input,video <username> +``` + +You will need to log out and log back in to see the new groups added to your user. Check groups your user belongs to with: +``` +groups +``` + +If everything was OK during your test you can now install the binaries to their place, in this example */usr/local*. +``` +sudo make install +``` + +This will install Kodi in the prefix provided in **[section 4.1](#41-configure-build)**. + +**TIP:** To override Kodi's install location, use `DESTDIR=<path>`. For example: +``` +sudo make install DESTDIR=$HOME/kodi +``` + +**[back to top](#table-of-contents)** | **[back to section top](#4-build-kodi)** + +## 5. Build binary add-ons +You can find a complete list of available binary add-ons **[here](https://github.com/xbmc/repo-binary-addons)**. + +In the following, two approaches to building binary add-ons are described. +While the workflow of in-tree building is more automated, +it is only supported as long as `-DCMAKE_INSTALL_PREFIX=/usr/local` is not changed from it's default of `/usr/local`. +Thus when changing `DCMAKE_INSTALL_PREFIX`, you must follow the out-of-tree building instructions. + +### 5.1. In-tree building of binary add-ons + +Change to Kodi's source code directory: +``` +cd $HOME/kodi +``` + +Build all add-ons: +``` +sudo make -j$(getconf _NPROCESSORS_ONLN) -C tools/depends/target/binary-addons PREFIX=/usr/local +``` + +Build specific add-ons: +``` +sudo make -j$(getconf _NPROCESSORS_ONLN) -C tools/depends/target/binary-addons PREFIX=/usr/local ADDONS="audioencoder.flac pvr.vdr.vnsi audiodecoder.snesapu" +``` + +Build a specific group of add-ons: +``` +sudo make -j$(getconf _NPROCESSORS_ONLN) -C tools/depends/target/binary-addons PREFIX=/usr/local ADDONS="pvr.*" +``` +For additional information on regular expression usage for ADDONS_TO_BUILD, view ADDONS_TO_BUILD section located here [Kodi add-ons CMake based buildsystem](../cmake/addons/README.md) + +**NOTE:** `PREFIX=/usr/local` should match Kodi's `-DCMAKE_INSTALL_PREFIX=` prefix used in **[section 4.1](#41-configure-build)**. + +**[back to top](#table-of-contents)** + + +### 5.2. Out-of-tree building of binary add-ons + +You can find a complete list of available binary add-ons **[here](https://github.com/xbmc/repo-binary-addons)**. +Exemplary, to install `pvr.demo`, follow below steps. +For other addons, simply adapt the repository based on the information found in the `.txt` associated with the respective addon **[here](https://github.com/xbmc/repo-binary-addons)** + +Some addons have dependencies. +You must install all required dependencies of an addon before installing the addon. +Required dependencies can be found by checking the `depends` folder and +it's subdirectories in the repository of the respective addons. + +A number of addons require the the `p8-platform` and `kodi-platform` add-ons. +Note that dependencies on `p8-platform` and `kodi-platform` are typically not declared in the `depends` folder. +They are only declared in the `CMakeLists.txt` file of the respective addon (e.g. via `find_package(p8-platform REQUIRED)`). +Below we demonstrate how to build these two. +First, the platform addon: + +``` +cd ~/src/ +git clone https://github.com/xbmc/platform.git +cd ~/src/platform/ +cmake -DCMAKE_INSTALL_PREFIX=/usr/local +make && make install +``` + +Then the kodi-platform add-on: + +``` +cd ~/src/ +git clone https://github.com/xbmc/kodi-platform.git +cd ~/src/kodi-platform/ +cmake -DCMAKE_INSTALL_PREFIX=/usr/local +make && make install +``` + +Finally, to install pvr.demo + +``` +cd ~/src +git clone https://github.com/kodi-pvr/pvr.demo.git +cd ~/src/pvr.demo/ +cmake -DCMAKE_INSTALL_PREFIX=/usr/local +make && make install +``` + +**NOTE:** `-DCMAKE_INSTALL_PREFIX=` should match Kodi's `-DCMAKE_INSTALL_PREFIX=` prefix used in **[section 4.1](#41-configure-build)**. + +## 6. Run Kodi +If you chose to install Kodi using `/usr` or `/usr/local` as the `-DCMAKE_INSTALL_PREFIX=`, you can just issue *kodi* in a terminal session. + +If you changed `-DCMAKE_INSTALL_PREFIX=` to install Kodi into some non-standard location, you will have to run Kodi directly: +``` +<CMAKE_INSTALL_PREFIX>/bin/kodi +``` + +To run Kodi in *portable* mode (useful for testing): +``` +<CMAKE_INSTALL_PREFIX>/bin/kodi -p +``` + +**[back to top](#table-of-contents)** + +## 7. Uninstall Kodi +``` +sudo make uninstall +``` +**WARNING:**: If you reran CMakes' configure step with a different `-DCMAKE_INSTALL_PREFIX=`, you will need to rerun configure with the correct path for this step to work correctly. + +If you would like to also remove any settings and third-party addons (skins, scripts, etc.) and Kodi configuration files, you should also run: +``` +rm -rf ~/.kodi +``` + +**[back to top](#table-of-contents)** + +## 8. Test suite +Kodi has a test suite which uses the Google C++ Testing Framework. This framework is provided directly in Kodi's source tree. + +Build and run Kodi's test suite: +``` +make check +``` + +Build Kodi's test suite without running it: +``` +make kodi-test +``` + +Run Kodi's test suite manually: +``` +./kodi-test +``` + +Show Kodi's test suite *help* notes: +``` +./kodi-test --gtest_help +``` + +Useful options: +``` +--gtest_list_tests + List the names of all tests instead of running them. + The name of TEST(Foo, Bar) is "Foo.Bar". + +--gtest_filter=POSITIVE_PATTERNS[-NEGATIVE_PATTERNS] + Run only the tests whose name matches one of the positive patterns but + none of the negative patterns. '?' matches any single character; '*' + matches any substring; ':' separates two patterns. +``` + +**[back to top](#table-of-contents)** + diff --git a/docs/README.RaspberryPi.md b/docs/README.RaspberryPi.md new file mode 100644 index 0000000..d5a9141 --- /dev/null +++ b/docs/README.RaspberryPi.md @@ -0,0 +1,5 @@ + + +# Raspberry Pi build guide + +The Raspberry Pi platform has been merged into the GBM build. See [README.Linux.md](README.Linux.md). diff --git a/docs/README.Ubuntu.md b/docs/README.Ubuntu.md new file mode 100644 index 0000000..3990483 --- /dev/null +++ b/docs/README.Ubuntu.md @@ -0,0 +1,177 @@ + + +# Debian/Ubuntu build guide +This guide has been tested with Ubuntu 16.04.4 (Xenial) x86_64, 18.04 (Bionic) and 20.04 (Focal). Please read it in full before you proceed to familiarize yourself with the build procedure. + +Several other distributions have **[specific build guides](README.md)** and a general **[Linux build guide](README.Linux.md)** is also available. + +## Table of Contents +1. **[Document conventions](#1-document-conventions)** +2. **[Get the source code](#2-get-the-source-code)** +3. **[Install the required packages](#3-install-the-required-packages)** + 3.1. **[Get build dependencies automagically](#31-get-build-dependencies-automagically)** + 3.2. **[Get build dependencies manually](#32-get-build-dependencies-manually)** + 3.3. **[Ubuntu <= 18.04](#33-ubuntu--1804)** +4. **[Build Kodi](#4-build-kodi)** + +## 1. Document conventions +This guide assumes you are using `terminal`, also known as `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order. + +This is a comment that provides context: +``` +this is a command +this is another command +and yet another one +``` + +**Example:** Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +Commands that contain strings enclosed in angle brackets denote something you need to change to suit your needs. +``` +git clone -b <branch-name> https://github.com/xbmc/xbmc kodi +``` + +**Example:** Clone Kodi's current Krypton branch: +``` +git clone -b Krypton https://github.com/xbmc/xbmc kodi +``` + +Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example: + +**NOTE:** Linux is user friendly... It's just very particular about who its friends are. +**TIP:** Algorithm is what developers call code they do not want to explain. +**WARNING:** Developers don't change light bulbs. It's a hardware problem. + +**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)** + +## 2. Get the source code +Make sure `git` is installed: +``` +sudo apt install git +``` + +Change to your `home` directory: +``` +cd $HOME +``` + +Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +**[back to top](#table-of-contents)** + +## 3. Install the required packages +You can install the required packages using one of two methods: automagically or manually. Please use the former whenever possible. + +**WARNING:** Oldest supported Ubuntu version is 16.04 (Xenial). It is possible to build on older Ubuntu releases but due to outdated packages it will require considerable fiddling. Sorry, you're on your own if you decide to go down that particular rabbit hole. + +### 3.1. Get build dependencies automagically +Add Kodi's *nightly* PPA to grab dependencies: +``` +sudo add-apt-repository -s ppa:team-xbmc/xbmc-nightly +``` + +If you're using Ubuntu 16.04, *build-depends* PPA is also required: +``` +sudo add-apt-repository ppa:team-xbmc/xbmc-ppa-build-depends +sudo apt update +``` + +Super-duper magic command to get the build dependencies: +``` +sudo apt build-dep kodi +``` + +**WARNING:** Do not use `aptitude` for the `build-dep` command. It doesn't resolve everything properly. + +If at a later point you decide you do not want Kodi's PPAs on your system, removing them is as easy as: +``` +sudo add-apt-repository -r ppa:team-xbmc/xbmc-nightly +sudo add-apt-repository -r ppa:team-xbmc/xbmc-ppa-build-depends +``` + +**NOTE:** For developers and anyone else who builds frequently it is recommended to install `ccache` to expedite subsequent builds of Kodi. + +You can install it with: +``` +sudo apt install ccache +``` + +**TIP:** If you have multiple computers at home, `distcc` will distribute build workloads of C and C++ code across several machines on a network. Team Kodi may not be willing to give support if problems arise using such a build configuration. + +You can install it with: +``` +sudo apt install distcc +``` + +### 3.2. Get build dependencies manually +If you get a `package not found` type of message with the below command, remove the offending package(s) from the install list and reissue the command. Take a note of the missing dependencies and, after a successful step completion, **[build the missing dependencies manually](README.Linux.md#31-build-missing-dependencies)**. + +**NOTE:** Kodi requires a compiler with C++17 support, i.e. gcc >= 7 or clang >= 5 + +Install build dependencies manually: +``` +sudo apt install debhelper autoconf automake autopoint gettext autotools-dev cmake curl default-jre doxygen gawk gcc gdc gperf libasound2-dev libass-dev libavahi-client-dev libavahi-common-dev libbluetooth-dev libbluray-dev libbz2-dev libcdio-dev libp8-platform-dev libcrossguid-dev libcurl4-openssl-dev libcwiid-dev libdbus-1-dev libdrm-dev libegl1-mesa-dev libenca-dev libflac-dev flatbuffers-dev libfmt-dev libfontconfig-dev libfreetype6-dev libfribidi-dev libfstrcmp-dev libgcrypt-dev libgif-dev libgles2-mesa-dev libgl1-mesa-dev libglu1-mesa-dev libgnutls28-dev libgpg-error-dev libgtest-dev libiso9660-dev libjpeg-dev liblcms2-dev libltdl-dev liblzo2-dev libmicrohttpd-dev libmysqlclient-dev libnfs-dev libogg-dev libpcre3-dev libplist-dev libpng-dev libpulse-dev libshairplay-dev libsmbclient-dev libspdlog-dev libsqlite3-dev libssl-dev libtag1-dev libtiff5-dev libtinyxml-dev libtool libudev-dev libva-dev libvdpau-dev libvorbis-dev libxmu-dev libxrandr-dev libxslt1-dev libxt-dev lsb-release meson nasm ninja-build python3-dev python3-pil python3-pip rapidjson-dev swig unzip uuid-dev zip zlib1g-dev +``` + +**WARNING:** Make sure you copy paste the entire line or you might receive an error or miss a few dependencies. + +If you're using Ubuntu 16.04, you also need to install: +``` +sudo apt install libcec4-dev libfmt3-dev liblircclient-dev +``` + +If you're using Ubuntu 18.04 and later, you also need to install: +``` +sudo apt install libcec-dev libfmt-dev liblirc-dev +``` + +Building for Wayland requires some extra packages: +``` +sudo apt install libglew-dev libwayland-dev libxkbcommon-dev waylandpp-dev wayland-protocols +``` + +Similarly, building for GBM also requires some extra packages: +``` +sudo apt install libgbm-dev libinput-dev libxkbcommon-dev +``` + +Optional packages that you might want to install for extra functionality (generating doxygen documentation, for instance): +``` +sudo apt install doxygen libcap-dev libsndio-dev libmariadbd-dev +``` + +**[back to top](#table-of-contents)** + +### 3.3 Ubuntu <= 18.04 +Ubuntu 18.04 and lower ship an outdated [Meson](https://mesonbuild.com/) and [nasm](https://nasm.us/) package. +In order to compile Kodi with AV1 support, you have to manually update both Meson and nasm. + +> This is a requirement by the [dav1d](https://code.videolan.org/videolan/dav1d) AV1 decoder used in ffmpeg. + +#### Meson +``` +pip3 install --user meson +``` + +Make sure `~/.local/bin` is in your PATH. + +Verify your Meson version by running `meson -v`. The version displayed should be >= 0.47.0. + +#### nasm (x86_64 / amd64) +``` +wget https://mirrors.edge.kernel.org/ubuntu/pool/universe/n/nasm/nasm_2.14-1_amd64.deb && sudo apt install ./nasm_2.14-1_amd64.deb +``` + +Verify your nasm version by running `nasm -v`. The version displayed should be >= 2.14. + +## 4. Build Kodi +See the general **[Linux build guide](README.Linux.md)** for reference. + +**[back to top](#table-of-contents)** + diff --git a/docs/README.Windows.md b/docs/README.Windows.md new file mode 100644 index 0000000..d07cac4 --- /dev/null +++ b/docs/README.Windows.md @@ -0,0 +1,253 @@ + + +# Windows build guide +This guide has been tested with Windows 10 Pro x64, version 21H2, build 19044.1415. Please read it in full before you proceed to familiarize yourself with the build procedure. + +## Table of Contents +1. **[Document conventions](#1-document-conventions)** +2. **[Prerequisites](#2-prerequisites)** +3. **[Get the source code](#3-get-the-source-code)** +4. **[Set up the build environment](#4-set-up-the-build-environment)** +5. **[Build Kodi automagically](#5-build-kodi-automagically)** +6. **[Build Kodi manually](#6-build-kodi-manually)** + +## 1. Document conventions +This guide assumes you are using `Developer Command Prompt for VS 2022`, also known as `terminal`, `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order. + +This is a comment that provides context: +``` +this is a command +this is another command +and yet another one +``` + +**Example:** Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +Commands that contain strings enclosed in angle brackets denote something you need to change to suit your needs. +``` +git clone -b <branch-name> https://github.com/xbmc/xbmc kodi +``` + +**Example:** Clone Kodi's current Matrix branch: +``` +git clone -b Matrix https://github.com/xbmc/xbmc kodi +``` + +Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example: + +**NOTE:** Linux is user friendly... It's just very particular about who its friends are. +**TIP:** Algorithm is what developers call code they do not want to explain. +**WARNING:** Developers don't change light bulbs. It's a hardware problem. + +**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)** + +## 2. Prerequisites +To build Kodi: +* **[CMake](https://cmake.org/download/)** (version 3.20 or greater is required to build Kodi, version 3.21 or greater to build with Visual Studio 2022) +* **[Git for Windows](https://gitforwindows.org/)** +* **[Java Runtime Environment (JRE)](http://www.oracle.com/technetwork/java/javase/downloads/index.html)** +* **[Nullsoft scriptable install system (NSIS)](http://nsis.sourceforge.net/Download)** (Only needed if you want to generate an installer file) +* **[Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)** or **[Visual Studio 2019](https://visualstudio.microsoft.com/vs/older-downloads/)** (Community Edition is fine) + +To run Kodi you need a relatively recent CPU with integrated GPU or discrete GPU with up-to-date graphics device-drivers installed from the manufacturer's website. +* **[AMD](https://support.amd.com/en-us/download)** +* **[Intel](https://downloadcenter.intel.com/product/80939/Graphics-Drivers)** +* **[NVIDIA](http://www.nvidia.com/Download/index.aspx)** + +### CMake install notes +All install screens should remain at their default values with the exception of the following. +* Under **Install options** change default to `Add CMake to system PATH for all users` or `Add CMake to system PATH for current user` (whichever you prefer). + +### Git for Windows install notes +All install screens should remain at their default values with the exception of the following two. +* Under **Choosing the default editor used by Git** change default to `Use Notepad++ as Git's default editor` or your favorite editor. +* Under **Adjust your PATH environment** change default to `Use Git and optional Unix tools from the Windows Command Prompt`. + +### JRE install notes +Default options are fine. +After install finishes, add java's executable file path to your `PATH` **[environment variable](http://www.java.com/en/download/help/path.xml)**. Should be similar to `C:\Program Files\Java\jre1.8.0_311\bin`. + +### NSIS install notes +Default options are fine. + +### Visual Studio 2022/2019 install notes +Start the Visual Studio installer and click **Workloads** select +* Under **Desktop & Mobile** section select + * `Desktop development with C++` + * `Universal Windows Platform development` (if compiling for UWP or UWP-ARM) + +Click in **Individual components** select +* Under **Compilers, build tools and runtimes** section select + * `MSVC v142/3 - VS 2019/22 C++ ARM build tools (Latest)` (if compiling for UWP-ARM) +* Under **SDKs, libraries, and frameworks** section select + * `Windows 10 SDK (10.0.18362.0)` (if compiling for UWP or UWP-ARM) + +Hit `Install`. Yes, it will download and install almost 8GB of stuff for x64 only or up to 20GB if everything is selected for UWP / UWP-ARM as well. + +**[back to top](#table-of-contents)** | **[back to section top](#2-prerequisites)** + +## 3. Get the source code +Change to your `home` directory: +``` +cd %userprofile% +``` + +Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +**[back to top](#table-of-contents)** + +## 4. Set up the build environment +To set up the build environment, several scripts must be called. + +**WARNING:** The scripts may fail if you have a space in the path to the bat files. + +Kodi can be built as either a normal 32bit or 64bit program, UWP 32bit and 64bit and UWP ARM 32bit. Unless there is a reason to prefer 32bit builds, we advise you to build Kodi for 64bit. + +**TIP:** Look for comments starting with `Or ...` and only execute the command(s) you need. + +Change to the 64bit build directory (**recommended**): +``` +cd %userprofile%\kodi\tools\buildsteps\windows\x64 +``` + +Or change to the 32bit build directory: +``` +cd %userprofile%\kodi\tools\buildsteps\windows\win32 +``` + +Or change to the UWP 64bit build directory: +``` +cd %userprofile%\kodi\tools\buildsteps\windows\x64-uwp +``` + +Or change to the UWP 32bit build directory: +``` +cd %userprofile%\kodi\tools\buildsteps\windows\win32-uwp +``` + +Or change to the UWP ARM 32bit build directory: +``` +cd %userprofile%\kodi\tools\buildsteps\windows\arm-uwp +``` + +Download dependencies: +``` +download-dependencies.bat +``` +**TIP:** Look for the `All formed packages ready!` success message. If you see the message `ERROR: Not all formed packages are ready!`, execute the command again until you see the success message. + +Download and setup the build environment for libraries: +``` +download-msys2.bat +``` + +Build FFmpeg: +``` +make-mingwlibs.bat +``` + +**[back to top](#table-of-contents)** | **[back to section top](#4-set-up-the-build-environment)** + +## 5. Build Kodi automagically +If all you want is to build a Kodi package ready to install, execute the command below and you're done. If you want to find out more about building, ignore this step and continue reading. Or execute the command below, grab some coffee and keep reading. Building takes a while anyway. + +Build a package ready to install: +``` +BuildSetup.bat +``` + +*Normal* 32bit and 64bit builds generate an `exe` file ready to run, located at `%userprofile%\kodi\kodi-build\Debug` or `%userprofile%\kodi\kodi-build\Release`, depending on the build config. An installer `exe` file, located at `%userprofile%\kodi\project\Win32BuildSetup`, is also generated. + +UWP builds generate `msix`, `appxsym` and `cer` files, located at `%userprofile%\kodi\project\UWPBuildSetup`. You can install them following this **[guide](https://kodi.wiki/view/HOW-TO:Install_Kodi_for_Universal_Windows_Platform)**. + +**NOTE:** To generate an exact replica of the official Kodi Windows installer, some additional steps are required: + +Build built-in add-ons (peripheral.joystick only) with command line: +``` +make-addons.bat peripheral.joystick +``` + +Build the installer with the command line: +``` +BuildSetup.bat nobinaryaddons clean +``` + +`BuildSetup.bat` without parameters also builds all the Kodi add-ons that are not needed because they are not included in the installer and the process is very time consuming. + +**[back to top](#table-of-contents)** + +## 6. Build Kodi manually +Change to your `home` directory: +``` +cd %userprofile% +``` + +Create an out-of-source build directory: +``` +mkdir kodi-build +``` + +Change to build directory: +``` +cd kodi-build +``` + +Configure build for 64bit (**recommended**): +``` +cmake -G "Visual Studio 17 2022" -A x64 -T host=x64 %userprofile%\kodi +``` + +Or configure build for 32bit: +``` +cmake -G "Visual Studio 17 2022" -A Win32 -T host=x64 %userprofile%\kodi +``` + +Or configure build for UWP 64bit: +``` +cmake -G "Visual Studio 17 2022" -A x64 -DCMAKE_SYSTEM_NAME=WindowsStore -DCMAKE_SYSTEM_VERSION=10.0.18362.0 -T host=x64 %userprofile%\kodi +``` + +Or configure build for UWP 32bit: +``` +cmake -G "Visual Studio 17 2022" -A Win32 -DCMAKE_SYSTEM_NAME=WindowsStore -DCMAKE_SYSTEM_VERSION=10.0.18362.0 -T host=x64 %userprofile%\kodi +``` + +Or configure build for UWP ARM 32bit: +``` +cmake -G "Visual Studio 17 2022" -A ARM -DCMAKE_SYSTEM_NAME=WindowsStore -DCMAKE_SYSTEM_VERSION=10.0.18362.0 -T host=x64 %userprofile%\kodi +``` + +**Visual Studio 2019:** + +Replace: +``` +-G "Visual Studio 17 2022" +``` + +With: +``` +-G "Visual Studio 16 2019" +``` + +Build Kodi: +Build a `Debug` binary: +``` +cmake --build . --config "Debug" +``` + +Or build a `Release` binary: +``` +cmake --build . --config "Release" +``` + +*Normal* 32bit and 64bit builds generate an `exe` file ready to run, located at `%userprofile%\kodi-build\Debug` or `%userprofile%\kodi-build\Release`, depending on the build config. +UWP builds generate `msix`, `appxsym` and `cer` files, located inside directories at `%userprofile%\kodi-build\AppPackages\kodi\`. You can install them following this **[guide](https://kodi.wiki/view/HOW-TO:Install_Kodi_for_Universal_Windows_Platform)**. + + +**[back to top](#table-of-contents)** | **[back to section top](#6-build-kodi-manually)** diff --git a/docs/README.iOS.md b/docs/README.iOS.md new file mode 100644 index 0000000..2787e71 --- /dev/null +++ b/docs/README.iOS.md @@ -0,0 +1,344 @@ + + +# iOS build guide +This guide has been tested using Xcode 11.3.1 running on MacOS 10.14.4 (Mojave). Please note this combination is the only version our CI system builds. The minimum OS requirement for this version of Xcode is MacOS 10.14.4. Other combinations may work but we provide no assurances that other combinations will build correctly and run identically to Team Kodi releases. It is meant to cross-compile Kodi for iOS using **[Kodi's unified depends build system](../tools/depends/README.md)**. Please read it in full before you proceed to familiarize yourself with the build procedure. + +## Table of Contents +1. **[Document conventions](#1-document-conventions)** +2. **[Prerequisites](#2-prerequisites)** +3. **[Get the source code](#3-get-the-source-code)** +4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)** + 4.1. **[Advanced Configure Options](#41-Advanced-Configure-Options)** +5. **[Build binary add-ons](#5-build-binary-add-ons)** + 5.1. **[Independent Add-on building](#51-Independent-Add-on-building)** + 5.2. **[Xcode project building](#52-Xcode-project-building)** +6. **[Build Kodi](#6-build-kodi)** + 6.1. **[Generate Project Files](#61-Generate-Project-Files)** + 6.2. **[Build with Xcode](#62-build)** +7. **[Package](#7-package)** +8. **[Install](#8-install)** +9. **[Gesture Handling](#9-gesture-handling)** + +## 1. Document conventions +This guide assumes you are using `terminal`, also known as `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order. + +This is a comment that provides context: +``` +this is a command +this is another command +and yet another one +``` + +**Example:** Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +Commands that contain strings enclosed in angle brackets denote something you need to change to suit your needs. +``` +git clone -b <branch-name> https://github.com/xbmc/xbmc kodi +``` + +**Example:** Clone Kodi's current Krypton branch: +``` +git clone -b Krypton https://github.com/xbmc/xbmc kodi +``` + +Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example: + +**NOTE:** Linux is user friendly... It's just very particular about who its friends are. +**TIP:** Algorithm is what developers call code they do not want to explain. +**WARNING:** Developers don't change light bulbs. It's a hardware problem. + +**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)** + +## 2. Prerequisites +* **[Java Development Kit (JDK)](http://www.oracle.com/technetwork/java/javase/downloads/index.html)** +* **[Xcode](https://developer.apple.com/xcode/)**. Install it from the AppStore or from the **[Apple Developer Homepage](https://developer.apple.com/)**. +* Device with **iOS 11.0 or newer** to install Kodi after build. + +Building for iOS should work with the following constellations of Xcode and macOS versions: + * Xcode 12.4 against iOS SDK 14.4 on 10.15.7 (Catalina)(recommended)(CI) + * Xcode 13.x against iOS SDK 15.5 on 12.x (Monterey)(recommended) + +Team Kodi CI infrastructure is limited, and therefore we only have the single combination tested. Newer xcode/macos combinations generally should work, however the team does not actively test/use pre-release versions, so use with caution. Earlier versions may work, however we dont actively support them, so use with caution. +**WARNING:** Start Xcode after installation finishes. You need to accept the licenses and install missing components. + +**[back to top](#table-of-contents)** + +## 3. Get the source code +Change to your `home` directory: +``` +cd $HOME +``` + +Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +**[back to top](#table-of-contents)** + +## 4. Configure and build tools and dependencies +Kodi can be built as a 64bit program for iOS. The dependencies are built in `$HOME/kodi/tools/depends` and installed into `/Users/Shared/xbmc-depends`. + +**TIP:** Look for comments starting with `Or ...` and only execute the command(s) you need. +**NOTE:** `--with-platform` is mandatory for all Apple platforms + +Configure build: +``` +cd $HOME/kodi/tools/depends +./bootstrap +./configure --host=aarch64-apple-darwin --with-platform=ios +``` + +Build tools and dependencies: +``` +make -j$(getconf _NPROCESSORS_ONLN) +``` + +**TIP:** By adding `-j<number>` to the make command, you can choose how many concurrent jobs will be used and expedite the build process. It is recommended to use `-j$(getconf _NPROCESSORS_ONLN)` to compile on all available processor cores. The build machine can also be configured to do this automatically by adding `export MAKEFLAGS="-j$(getconf _NPROCESSORS_ONLN)"` to your shell config (e.g. `~/.bashrc`). + +**WARNING:** Look for the `Dependencies built successfully.` success message. If in doubt run a single threaded `make` command until the message appears. If the single make fails, clean the specific library by issuing `make -C target/<name_of_failed_lib> distclean` and run `make`again. + +**NOTE:** **Advanced developers** may want to specify an iOS SDK version (if multiple versions are installed) in the configure line(s) shown above. The example below would use the iOS SDK 11.0: +``` +./configure --host=aarch64-apple-darwin --with-platform=ios --with-sdk=11.0 +``` + +### 4.1. Advanced Configure Options + + +**All platforms:** + +``` +--with-toolchain=<path> +``` + specify path to toolchain. Auto set for android. Defaults to xcode root for darwin, /usr for linux + +``` +--enable-debug=<yes:no> +``` + enable debugging information (default is yes) + +``` +--disable-ccache +``` + disable ccache + +``` +--with-tarballs=<path> +``` + path where tarballs will be saved [prefix/xbmc-tarballs] + +``` +--with-cpu=<cpu> +``` + optional. specify target cpu. guessed if not specified + +``` +--with-linker=<linker> +``` + specify linker to use. (default is ld) + +``` +--with-platform=<platform> +``` + target platform + +``` +--enable-gplv3=<yes:no> +``` + enable gplv3 components. (default is yes) + +``` +--with-target-cflags=<cflags> +``` + C compiler flags (target) + +``` +--with-target-cxxflags=<cxxflags> +``` + C++ compiler flags (target) + +``` +--with-target-ldflags=<ldflags> +``` + linker flags. Use e.g. for -l<lib> (target) + +``` +--with-ffmpeg-options +``` + FFmpeg configure options, e.g. --enable-vaapi (target) + + +**Apple Specific:** + +``` +--with-sdk=<sdknumber> +``` + specify sdk platform version. + + +**[back to top](#table-of-contents)** | **[back to section top](#4-configure-and-build-tools-and-dependencies)** + +## 5. Build binary add-ons + +You can find a complete list of available binary add-ons **[here](https://github.com/xbmc/repo-binary-addons)**. + +## 5.1. Independent Add-on building + +Change to Kodi's source code directory: +``` +cd $HOME/kodi +``` + +Build all add-ons: +``` +make -C tools/depends/target/binary-addons +``` + +Build specific add-ons: +``` +make -C tools/depends/target/binary-addons ADDONS="audioencoder.flac pvr.vdr.vnsi audiodecoder.snesapu" +``` + +Build a specific group of add-ons: +``` +make -j$(getconf _NPROCESSORS_ONLN) -C tools/depends/target/binary-addons ADDONS="pvr.*" +``` +For additional information on regular expression usage for ADDONS_TO_BUILD, view ADDONS_TO_BUILD section located here [Kodi add-ons CMake based buildsystem](../cmake/addons/README.md) + +## 5.2. Xcode project building + +Binary addons will be built as a dependency in the Xcode project. You can choose the addons +you wish to build during the Xcode project generation step + +Generate Xcode project to build specific add-ons: +```sh +make -C tools/depends/target/cmakebuildsys CMAKE_EXTRA_ARGUMENTS="-DENABLE_XCODE_ADDONBUILD=ON -DADDONS_TO_BUILD='audioencoder.flac pvr.vdr.vnsi audiodecoder.snesapu'" +``` + +Generate Xcode project to build a specific group of add-ons: +```sh +make -C tools/depends/target/cmakebuildsys CMAKE_EXTRA_ARGUMENTS="-DENABLE_XCODE_ADDONBUILD=ON -DADDONS_TO_BUILD='pvr.*'" +``` + +For additional information on regular expression usage for ADDONS_TO_BUILD, view ADDONS_TO_BUILD section located at [Kodi add-ons CMake based buildsystem](../cmake/addons/README.md) + +Generate Xcode project to build all add-ons automatically: +```sh +make -C tools/depends/target/cmakebuildsys CMAKE_EXTRA_ARGUMENTS="-DENABLE_XCODE_ADDONBUILD=ON" +``` + +**TIP:** If you wish to not automatically build addons added to your xcode project, omit +`-DENABLE_XCODE_ADDONBUILD=ON`. The target will be added to the project, but the dependency + will not be set to automatically build +**TIP:** Binary add-ons added to the generated Xcode project can be built independently of +the Kodi app by selecting the scheme/target `binary-addons` in the Xcode project. +You can also build the binary-addons target via xcodebuild. This will not build the Kodi +App, but will build any/all binary addons added for the project Generation. +```sh +xcodebuild -config "Debug" -target binary-addons +``` + +**[back to top](#table-of-contents)** + +## 6. Build Kodi + +## 6.1. Generate Project Files + +Before you can use Xcode to build Kodi, the Xcode project has to be generated with CMake. CMake is built as part of the dependencies and doesn't have to be installed separately. A toolchain file is also generated and is used to configure CMake. + +Create an out-of-source build directory: +``` +mkdir $HOME/kodi-build +``` +Generate Xcode project as per configure command in **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)**: +``` +make -C tools/depends/target/cmakebuildsys BUILD_DIR=$HOME/kodi-build +``` + +**TIP:** BUILD_DIR can be omitted, and project will be created in $HOME/kodi/build +Change all relevant paths onwards if omitted. + +Additional cmake arguments can be supplied via the CMAKE_EXTRA_ARGUMENTS command line variable + +Alternatively: +` +Generate Xcode project for ARM 64bit (**recommended**): +``` +cd $HOME/kodi-build +/Users/Shared/xbmc-depends/x86_64-darwin17.5.0-native/bin/cmake -G Xcode -DCMAKE_TOOLCHAIN_FILE=/Users/Shared/xbmc-depends/iphoneos11.3_arm64-target-debug/share/Toolchain.cmake $HOME/kodi +``` + +**WARNING:** The toolchain file location differs depending on your iOS and SDK version. You have to replace `x86_64-darwin15.6.0-native` and `iphoneos11.3_arm64-target-debug` in the paths above with the correct ones on your system. + +You can check `Users/Shared/xbmc-depends` directory content with: +``` +ls -l /Users/Shared/xbmc-depends +``` +## 6.2 Build + +**Start Xcode, open the Kodi project file** (`kodi.xcodeproj`) located in `$HOME/kodi-build` and hit `Build`. + +**WARNING:** If you have selected a specific iOS SDK Version in step 4 then you might need to adapt the active target to use the same iOS SDK version, otherwise build will fail. Be sure to select a device configuration. Building for simulator is not supported. + +**Alternatively**, you can also build via Xcode from the command-line with `xcodebuild`: + +Build Kodi: +``` +cd $HOME/kodi-build +xcodebuild -config "Debug" -jobs $(getconf _NPROCESSORS_ONLN) +``` + +**TIP:** You can specify Release instead of Debug as -config parameter. + +**[back to top](#table-of-contents)** | **[back to section top](#6-build-kodi)** + +## 7. Package +CMake generates a target called `deb` which will package Kodi ready for distribution. After Kodi has been built, the target can be triggered by selecting it in Xcode active scheme or manually running + +``` +cd $HOME/kodi-build +xcodebuild -target deb +``` + +**Alternatively** + +``` +cd $HOME/kodi-build +/Users/Shared/xbmc-depends/x86_64-darwin17.5.0-native/bin/cmake --build . --target "deb" --config "Debug" +``` + +**[back to top](#table-of-contents)** + +## 8. Install +On jailbroken devices the resulting deb file can be copied to the iOS device via *ssh/scp* and installed manually. You need to SSH into the iOS device and issue: +``` +dpkg -i <name of the deb file> +``` + +If you are a developer with an official Apple code signing identity you can deploy Kodi via Xcode to work on it on non-jailbroken devices. For this to work you need to alter the Xcode project by setting your codesign identity. Just select the *iPhone Developer* shortcut. +It's also important that you select the signing on all 4 spots in the project settings. After the last buildstep, our support script will do a full sign of all binaries and bundle them with the given identity, including all the `*.viz`, `*.pvr`, `*.so`, etc. files Xcode doesn't know anything about. This should allow you to deploy Kodi to all non-jailbroken devices the same way you deploy normal apps to. +In that case Kodi will be sandboxed like any other app. All Kodi files are then located in the sandboxed *Documents* folder and can be easily accessed via iTunes file sharing. + +From Xcode7 on this approach is also available for non paying app developers (Apple allows self signing from now on). + +**[back to top](#table-of-contents)** + +## 9. Gesture Handling + +| Gesture | Action | +| ---------------------------------------- | -------------------------- | +| Double finger swipe left | Back | +| Double finger tap/single finger long tap | Right mouse | +| Single finger tap | Left mouse | +| Panning, and flicking | For navigating in lists | +| Dragging | For scrollbars and sliders | +| Zoom gesture | In the picture viewer | + +Gestures can be adapted in **[system/keymaps/touchscreen.xml](https://github.com/xbmc/xbmc/blob/master/system/keymaps/touchscreen.xml)**. + +**[back to top](#table-of-contents)** + diff --git a/docs/README.macOS.md b/docs/README.macOS.md new file mode 100644 index 0000000..5590e8a --- /dev/null +++ b/docs/README.macOS.md @@ -0,0 +1,374 @@ + + +# macOS build guide +This guide has been tested using Xcode 11.3.1 running on MacOS 10.14.4 (Mojave). Please note this combination is the only version our CI system builds. The minimum OS requirement for this version of Xcode is MacOS 10.14.4. Other combinations may work but we provide no assurances that other combinations will build correctly and run identically to Team Kodi releases. It is meant to build Kodi for macOS using **[Kodi's unified depends build system](../tools/depends/README.md)**. Please read it in full before you proceed to familiarize yourself with the build procedure. + +## Table of Contents +1. **[Document conventions](#1-document-conventions)** +2. **[Prerequisites](#2-prerequisites)** +3. **[Get the source code](#3-get-the-source-code)** +4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)** + 4.1. **[Advanced Configure Options](#41-Advanced-Configure-Options)** +5. **[Build binary add-ons](#5-build-binary-add-ons)** +6. **[Build Kodi](#6-build-kodi)** + 6.1. **[Build with Xcode](#61-build-with-xcode)** + 6.2. **[Build with xcodebuild](#62-build-with-xcodebuild)** + 6.3. **[Build with make](#63-build-with-make)** +7. **[Run Kodi](#7-run-kodi)** + 7.1. **[Built with Xcode or xcodebuild](#71-built-with-xcode-or-xcodebuild)** + 7.2. **[Built with make](#72-built-with-make)** +8. **[Package](#8-package)** +9. **[Install](#9-install)** + +## 1. Document conventions +This guide assumes you are using `terminal`, also known as `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order. + +This is a comment that provides context: +``` +this is a command +this is another command +and yet another one +``` + +**Example:** Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +Commands that contain strings enclosed in angle brackets denote something you need to change to suit your needs. +``` +git clone -b <branch-name> https://github.com/xbmc/xbmc kodi +``` + +**Example:** Clone Kodi's current Krypton branch: +``` +git clone -b Krypton https://github.com/xbmc/xbmc kodi +``` + +Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example: + +**NOTE:** Linux is user friendly... It's just very particular about who its friends are. +**TIP:** Algorithm is what developers call code they do not want to explain. +**WARNING:** Developers don't change light bulbs. It's a hardware problem. + +**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)** + +## 2. Prerequisites +* **[Java Development Kit (JDK)](http://www.oracle.com/technetwork/java/javase/downloads/index.html)** +* **[Xcode](https://developer.apple.com/xcode/)**. Install it from the AppStore or from the **[Apple Developer Homepage](https://developer.apple.com/)**. +* Device with **OSX 10.13 or newer** to run Kodi after build. + +Building for OSX/macOS should work with the following constellations of Xcode and OSX/macOS versions: + * Xcode 12.4 against MacOSX SDK 11.1 on 10.15.7 (Catalina)(recommended)(CI) + * Xcode 13.x against MacOSX SDK 12.3 on 12.x (Monterey)(recommended) + +Team Kodi CI infrastructure is limited, and therefore we only have the single combination tested. Newer xcode/macos combinations generally should work, however the team does not actively test/use pre-release versions, so use with caution. Earlier versions may work, however we dont actively support them, so use with caution. +**WARNING:** Start Xcode after installation finishes. You need to accept the licenses and install missing components. + +**[back to top](#table-of-contents)** + +## 3. Get the source code +Change to your `home` directory: +``` +cd $HOME +``` + +Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +**[back to top](#table-of-contents)** + +## 4. Configure and build tools and dependencies +Kodi can be built as either a 32bit or 64bit program. The dependencies are built in `$HOME/kodi/tools/depends` and installed into `/Users/Shared/xbmc-depends`. + +**TIP:** Look for comments starting with `Or ...` and only execute the command(s) you need. +**NOTE:** `--with-platform` is mandatory for all Apple platforms + +Configure build (x86 intel): +``` +cd $HOME/kodi/tools/depends +./bootstrap +./configure --host=x86_64-apple-darwin --with-platform=macos +``` + +Configure build (apple silicon): +``` +cd $HOME/kodi/tools/depends +./bootstrap +./configure --host=aarch64-apple-darwin --with-platform=macos +``` + +Build tools and dependencies: +``` +make -j$(getconf _NPROCESSORS_ONLN) +``` + +**TIP:** By adding `-j<number>` to the make command, you can choose how many concurrent jobs will be used and expedite the build process. It is recommended to use `-j$(getconf _NPROCESSORS_ONLN)` to compile on all available processor cores. The build machine can also be configured to do this automatically by adding `export MAKEFLAGS="-j$(getconf _NPROCESSORS_ONLN)"` to your shell config (e.g. `~/.bashrc`). + +**WARNING:** Look for the `Dependencies built successfully.` success message. If in doubt run a single threaded `make` command until the message appears. If the single make fails, clean the specific library by issuing `make -C target/<name_of_failed_lib> distclean` and run `make`again. + +**NOTE:** **Advanced developers** may want to specify an SDK version (if multiple versions are installed) in the configure line(s) shown above. The example below would use SDK 10.13: +``` +./configure --host=x86_64-apple-darwin --with-platform=macos --with-sdk=10.13 +``` + +Developers can also select native windowing/input handling with the following +``` +./configure --host=x86_64-apple-darwin --with-platform=macos --with-windowsystem=native +``` + +### 4.1. Advanced Configure Options + + +**All platforms:** + +``` +--with-toolchain=<path> +``` + specify path to toolchain. Auto set for android. Defaults to xcode root for darwin, /usr for linux + +``` +--enable-debug=<yes:no> +``` + enable debugging information (default is yes) + +``` +--disable-ccache +``` + disable ccache + +``` +--with-tarballs=<path> +``` + path where tarballs will be saved [prefix/xbmc-tarballs] + +``` +--with-cpu=<cpu> +``` + optional. specify target cpu. guessed if not specified + +``` +--with-linker=<linker> +``` + specify linker to use. (default is ld) + +``` +--with-platform=<platform> +``` + target platform + +``` +--enable-gplv3=<yes:no> +``` + enable gplv3 components. (default is yes) + +``` +--with-target-cflags=<cflags> +``` + C compiler flags (target) + +``` +--with-target-cxxflags=<cxxflags> +``` + C++ compiler flags (target) + +``` +--with-target-ldflags=<ldflags> +``` + linker flags. Use e.g. for -l<lib> (target) + +``` +--with-ffmpeg-options +``` + FFmpeg configure options, e.g. --enable-vaapi (target) + +**Apple Specific:** + +``` +--with-windowsystem=<native:sdl> +``` + Windowing system to use (default is sdl when not provided). arm64 MacOS requires native + +``` +--with-sdk=<sdknumber> +``` + specify sdk platform version. + +**[back to top](#table-of-contents)** | **[back to section top](#4-configure-and-build-tools-and-dependencies)** + +## 5. Build binary add-ons +You can find a complete list of available binary add-ons **[here](https://github.com/xbmc/repo-binary-addons)**. + +Change to Kodi's source code directory: +``` +cd $HOME/kodi +``` + +There are multiple possibilities to choose which addons are built. The following 3 examples will give an idea. + +(1) Build all add-ons: +``` +make -j$(getconf _NPROCESSORS_ONLN) -C tools/depends/target/binary-addons +``` +OR + +(2) Build specific add-ons: +``` +make -j$(getconf _NPROCESSORS_ONLN) -C tools/depends/target/binary-addons ADDONS="audioencoder.flac pvr.vdr.vnsi audiodecoder.snesapu" +``` +OR + +(3) Build a specific group of add-ons: +``` +make -j$(getconf _NPROCESSORS_ONLN) -C tools/depends/target/binary-addons ADDONS="pvr.*" +``` +For additional information on regular expression usage for ADDONS_TO_BUILD, view ADDONS_TO_BUILD section located at [Kodi add-ons CMake based buildsystem](../cmake/addons/README.md) + +**[back to top](#table-of-contents)** + +## 6. Build Kodi +Before you can use Xcode to build Kodi, the Xcode project has to be generated with CMake. CMake is built as part of the dependencies and doesn't have to be installed separately. A toolchain file is also generated and is used to configure CMake. + +### 6.1. Build with Xcode +Create an out-of-source build directory: +``` +mkdir $HOME/kodi-build +``` +Generate Xcode project as per configure command in **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)**: +``` +make -C tools/depends/target/cmakebuildsys BUILD_DIR=$HOME/kodi-build GEN=Xcode +``` + +To explicitly select the windowing/input system to use do the following (default is to use SDL if not provided) +``` +make -C tools/depends/target/cmakebuildsys BUILD_DIR=$HOME/kodi-build GEN=Xcode APP_WINDOW_SYSTEM=native +``` + +**TIP:** BUILD_DIR can be omitted, and project will be created in $HOME/kodi/build +Change all relevant paths onwards if omitted. + +Additional cmake arguments can be supplied via the CMAKE_EXTRA_ARGUMENTS command line variable + +**Alternatively** + +Change to build directory: +``` +cd $HOME/kodi-build +``` + +Generate Xcode project (x86_64 intel): +``` +/Users/Shared/xbmc-depends/x86_64-darwin17.5.0-native/bin/cmake -G Xcode -DCMAKE_TOOLCHAIN_FILE=/Users/Shared/xbmc-depends/macosx10.13_x86_64-target-debug/share/Toolchain.cmake ../kodi +``` + +**WARNING:** The toolchain file location differs depending on SDK version. You have to replace `x86_64-darwin17.5.0-native` and `macosx10.13_x86_64-target-debug` in the paths above with the correct ones on your system. + +You can check `Users/Shared/xbmc-depends` directory content with: +``` +ls -l /Users/Shared/xbmc-depends +``` + +**Start Xcode, open the Kodi project file** (`kodi.xcodeproj`) located in `$HOME/kodi-build` and hit `Build`. + +**WARNING:** If you have selected a specific SDK version in **[step 4](#4-configure-and-build-tools-and-dependencies)** then you might need to adapt the active target to use the same SDK version, otherwise build will fail. Be sure to select a device configuration. Building for simulator is **not** supported. + +### 6.2. Build with xcodebuild +Alternatively, you can also build via Xcode from the command-line with `xcodebuild`, triggered by CMake: + +Build Kodi: +``` +cd $HOME/kodi-build +xcodebuild -config "Debug" -jobs $(getconf _NPROCESSORS_ONLN) +``` + +**TIP:** You can specify Release instead of Debug as -config parameter. + +**Alternatively** + +Build Kodi: +``` +/Users/Shared/xbmc-depends/x86_64-darwin17.5.0-native/bin/cmake --build . --config "Debug" -- -verbose -jobs $(getconf _NPROCESSORS_ONLN) +``` + +**TIP:** You can specify `Release` instead of `Debug` as `--config` parameter. + +### 6.3. Build with make +CMake is also able to generate makefiles that can be used to build with make. + +Change to Kodi's source code directory: +``` +cd $HOME/kodi +``` + +Generate makefiles: +``` +make -C tools/depends/target/cmakebuildsys +``` + +**TIP:** BUILD_DIR can be provided as an argument to cmakebuildsys. This allows you to provide an alternate build location. Change all paths onwards as required if BUILD_DIR option used. +``` +mkdir $HOME/kodi-build +make -C tools/depends/target/cmakebuildsys BUILD_DIR=$HOME/kodi-build +``` + +Build Kodi: +``` +make -j$(getconf _NPROCESSORS_ONLN) -C build +``` + +**[back to top](#table-of-contents)** | **[back to section top](#6-build-kodi)** + +## 7. Run Kodi +### 7.1. Built with Xcode or xcodebuild +After build finishes, you can run Kodi from Xcode or from terminal. + +Run `Debug` config from terminal: +``` +$HOME/kodi-build/Debug/kodi.bin +``` + +Run `Release` config from terminal: +``` +$HOME/kodi-build/Release/kodi.bin +``` + +### 7.2. Built with make +After build finishes, you can run Kodi from terminal: +``` +$HOME/kodi/build/kodi.bin +``` + +**[back to top](#table-of-contents)** + +## 8. Package +CMake generates a target called `dmg` which will package Kodi ready for distribution. After Kodi has been built, the target can be triggered by selecting it in Xcode active scheme or manually running + +``` +cd $HOME/kodi-build +xcodebuild -target dmg +```` +**OR** +``` +cd $HOME/kodi-build +/Users/Shared/xbmc-depends/x86_64-darwin17.5.0-native/bin/cmake --build . --target "dmg" --config "Debug" +``` + +Generated `dmg` file will be inside `$HOME/kodi-build/tools/darwin/packaging/osx/`. + +Alternatively, if you built using make: +``` +cd $HOME/kodi-build +make dmg +``` + +Generated `dmg` file will be inside `$HOME/kodi-build/tools/darwin/packaging/osx/`. + +**[back to top](#table-of-contents)** + +## 9. Install +Kodi can be installed like any other app. + +**[back to top](#table-of-contents)** + diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..836f1c3 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,23 @@ + + +# Kodi's Documentation Home +Welcome to Kodi's documentation home. Geared at developers, it contains platform specific build guides, **[code guidelines](CODE_GUIDELINES.md)**, a **[git guide](GIT-FU.md)** streamlined for Kodi's workflow and Doxygen's resources, ready to generate **[code documentation](doxygen/README.md)**. + +If you haven't done so, we encourage you to read our **[contributing guide](CONTRIBUTING.md)** first. It contains pertinent information about our development model. + +## Building Kodi +Kodi uses CMake as its building system but instructions are highly dependent on your operating system and target platform. Choose your platform below and read the guide carefully before proceeding. + +<p align="center"> + <a href="README.Android.md" title="Android"><img src="resources/android.svg" height="78"></a> + <a href="README.Fedora.md" title="Fedora"><img src="resources/fedora.svg" height="78"></a> + <a href="README.FreeBSD.md" title="FreeBSD"><img src="resources/freebsd.svg" height="78"></a> + <a href="README.iOS.md" title="iOS"><img src="resources/ios.svg" height="78"></a> + <a href="README.Linux.md" title="Linux"><img src="resources/linux.svg" height="78"></a> + <a href="README.macOS.md" title="macOS"><img src="resources/macos.svg" height="78"></a> + <a href="README.openSUSE.md" title="openSUSE"><img src="resources/opensuse.svg" height="78"></a> + <a href="README.tvOS.md" title="tvOS"><img src="resources/tvos.svg" height="78"></a> + <a href="README.Ubuntu.md" title="Ubuntu"><img src="resources/ubuntu.svg" height="78"></a> + <a href="README.Windows.md" title="Windows"><img src="resources/windows.svg" height="78"></a> +</p> + diff --git a/docs/README.openSUSE.md b/docs/README.openSUSE.md new file mode 100644 index 0000000..98e8182 --- /dev/null +++ b/docs/README.openSUSE.md @@ -0,0 +1,138 @@ + + +# openSUSE build guide +This guide has been tested with openSUSE Tumbleweed x86_64. Please read it in full before you proceed to familiarize yourself with the build procedure. + +Several other distributions have **[specific build guides](README.md)** and a general **[Linux build guide](README.Linux.md)** is also available. + +**Do not use openSUSE Leap**. Wiser people than us decided that in 2018 `gcc v4.8.5` is the best **stable** release openSUSE Leap 42.3 can provide by default. Installing/using another release along side it is a real PITA. + +## Table of Contents +1. **[Document conventions](#1-document-conventions)** +2. **[Get the source code](#2-get-the-source-code)** +3. **[Install the required packages](#3-install-the-required-packages)** + 3.1. **[Build missing dependencies](#31-build-missing-dependencies)** +4. **[Build Kodi](#4-build-kodi)** + +## 1. Document conventions +This guide assumes you are using `terminal`, also known as `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order. + +This is a comment that provides context: +``` +this is a command +this is another command +and yet another one +``` + +**Example:** Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +Commands that contain strings enclosed in angle brackets denote something you need to change to suit your needs. +``` +git clone -b <branch-name> https://github.com/xbmc/xbmc kodi +``` + +**Example:** Clone Kodi's current Krypton branch: +``` +git clone -b Krypton https://github.com/xbmc/xbmc kodi +``` + +Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example: + +**NOTE:** Linux is user friendly... It's just very particular about who its friends are. +**TIP:** Algorithm is what developers call code they do not want to explain. +**WARNING:** Developers don't change light bulbs. It's a hardware problem. + +**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)** + +## 2. Get the source code +Make sure `git` is installed: +``` +sudo zypper install git +``` + +Clone Kodi's current master branch: +``` +cd $HOME +git clone https://github.com/xbmc/xbmc kodi +``` + +**[back to top](#table-of-contents)** + +## 3. Install the required packages +Add `opensuse-multimedia-libs` repository because some needed packages are non-OSS: +``` +sudo zypper ar -f http://ftp.gwdg.de/pub/opensuse/repositories/multimedia:/libs/openSUSE_Tumbleweed/ opensuse-multimedia-libs +sudo zypper ref +``` + +**NOTE:** A message will ask you to accept the key. Enter `a`, the *trust always* option. + +If you get a `package not found` type of message with the below command, remove the offending package(s) from the install list and reissue the command. Take a note of the missing dependencies and, after a successful step completion, **[build the missing dependencies manually](#31-build-missing-dependencies)**. + +**NOTE:** Kodi requires a compiler with C++17 support, i.e. gcc >= 7 or clang >= 5 + +Install build dependencies: +``` +sudo zypper install alsa-devel autoconf automake bluez-devel boost-devel capi4linux-devel ccache cmake doxygen flac-devel fribidi-devel fstrcmp-devel gcc gcc-c++ gettext-devel giflib-devel glew-devel googletest gperf java-openjdk libass-devel libavahi-devel libbluray-devel libbz2-devel libcap-devel libcap-ng-devel libcdio-devel libcec-devel libcurl-devel libdvdread-devel libgudev-1_0-devel libidn2-devel libjasper-devel libjpeg-devel liblcms2-devel libmad-devel libmicrohttpd-devel libmodplug-devel libmpeg2-devel libmysqlclient-devel libnfs-devel libogg-devel libpcap-devel libplist-devel libpng12-devel libpulse-devel libsamplerate-devel libsmbclient-devel libtag-devel libtiff-devel libtool libudev-devel libuuid-devel libva-devel libvdpau-devel libvorbis-devel libXrandr-devel libXrender-devel libxslt-devel lirc-devel lzo-devel make Mesa-libEGL-devel Mesa-libGLESv2-devel Mesa-libGLESv3-devel nasm patch pcre-devel python3-devel python3-Pillow randrproto-devel renderproto-devel shairplay-devel sqlite3-devel swig tinyxml-devel +``` + +**WARNING:** Make sure you copy paste the entire line or you might receive an error or miss a few dependencies. + +Building for Wayland requires some extra packages: +``` +sudo zypper install wayland-devel libwayland-egl1 libwayland-egl-devel libxkbcommon-devel scons wayland-protocols-devel +``` + +Similarly, building for GBM also requires some extra packages: +``` +sudo zypper install libgbm-devel libinput-devel libxkbcommon-devel +``` + +**WARNING:** Fedora repositories don't have install candidates for `libfmt`, `rapidjson` and `waylandpp`. See **[build missing dependencies manually](#31-build-missing-dependencies)** section before you proceed. + +Optional packages that you might want to install for extra functionality (generating doxygen documentation, for instance): +``` +sudo zypper install doxygen sndio-devel libmariadb-devel +``` + +**NOTE:** For developers and anyone else who builds frequently it is recommended to install `ccache` to expedite subsequent builds of Kodi. + +You can install it with: +``` +sudo zypper install ccache +``` + +**TIP:** If you have multiple computers at home, `distcc` will distribute build workloads of C and C++ code across several machines on a network. Team Kodi may not be willing to give support if problems arise using such a build configuration. + +You can install it with: +``` +sudo zypper install distcc +``` + +### 3.1. Build missing dependencies +See the general **[Linux build guide](README.Linux.md)** for reference. + +Change to Kodi's source code directory: +``` +cd $HOME/kodi +``` + +Build and install missing dependencies from repositories (*flatbuffers*, *libfmt*, *rapidjson* and *waylandpp*): +``` +sudo make -C tools/depends/target/flatbuffers PREFIX=/usr/local +sudo make -C tools/depends/target/libfmt PREFIX=/usr/local +sudo make -C tools/depends/target/rapidjson PREFIX=/usr/local +sudo make -C tools/depends/target/waylandpp PREFIX=/usr/local +``` + +**[back to top](#table-of-contents)** | **[back to section top](#3-install-the-required-packages)** + +## 4. Build Kodi +See the general **[Linux build guide](README.Linux.md)** for reference. + +**[back to top](#table-of-contents)** + + diff --git a/docs/README.tvOS.md b/docs/README.tvOS.md new file mode 100644 index 0000000..032d699 --- /dev/null +++ b/docs/README.tvOS.md @@ -0,0 +1,379 @@ + + +# tvOS build guide +This guide has been tested using Xcode 11.3.1 running on MacOS 10.15.2 (Catalina). Please note this combination is the only version our CI system builds. The minimum OS requirement for this version of Xcode is MacOS 10.14.4. Other combinations may work but we provide no assurances that other combinations will build correctly and run identically to Team Kodi releases. It is meant to cross-compile Kodi for tvOS 11+ (AppleTV 4/4K) using **[Kodi's unified depends build system](../tools/depends/README.md)**. Please read it in full before you proceed to familiarize yourself with the build procedure. + +## Table of Contents +1. **[Document conventions](#1-document-conventions)** +2. **[Prerequisites](#2-prerequisites)** +3. **[Get the source code](#3-get-the-source-code)** +4. **[Configure and build tools and dependencies](#4-configure-and-build-tools-and-dependencies)** + 4.1. **[Advanced Configure Options](#41-Advanced-Configure-Options)** +5. **[Generate Kodi Build files](#5-Generate-Kodi-Build-files)** + 5.1. **[Generate XCode Project Files](#51-Generate-Xcode-Project-Files)** + 5.2. **[Build with Xcode](#62-build)** +6. **[Build Kodi](#6-build-kodi)** + 6.1. **[Build with Xcode](#61-Build-with-Xcode)** + 6.2. **[Build with xcodebuild](#62-Build-with-xcodebuild)** +7. **[Packaging to distribute as deb](#7-Packaging-to-distribute-as-deb)** + 7.1. **[Package via Xcode](#71-Package-via-Xcode)** + 7.2. **[Package via Xcodebuild](#72-Package-via-Xcodebuild)** +8. **[Signing](#8-Signing)** + 8.1. **[Signing using a developer account](#81-Signing-using-a-developer-account)** + 8.2. **[Using iOS App Signer to install](#82-Using-iOS-App-Signer-to-install)** +9. **[Install](#9-Install)** + 9.1. **[Jailbroken devices](#91-Jailbroken-devices)** + 9.2. **[Using Xcode to install](#92-Using-Xcode-to-install)** + +## 1. Document conventions +This guide assumes you are using `terminal`, also known as `console`, `command-line` or simply `cli`. Commands need to be run at the terminal, one at a time and in the provided order. + +This is a comment that provides context: +``` +this is a command +this is another command +and yet another one +``` + +**Example:** Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +Commands that contain strings enclosed in angle brackets denote something you need to change to suit your needs. +``` +git clone -b <branch-name> https://github.com/xbmc/xbmc kodi +``` + +**Example:** Clone Kodi's current Krypton branch: +``` +git clone -b Krypton https://github.com/xbmc/xbmc kodi +``` + +Several different strategies are used to draw your attention to certain pieces of information. In order of how critical the information is, these items are marked as a note, tip, or warning. For example: + +**NOTE:** Linux is user friendly... It's just very particular about who its friends are. +**TIP:** Algorithm is what developers call code they do not want to explain. +**WARNING:** Developers don't change light bulbs. It's a hardware problem. + +**[back to top](#table-of-contents)** | **[back to section top](#1-document-conventions)** + +## 2. Prerequisites +* **[Java Development Kit (JDK)](http://www.oracle.com/technetwork/java/javase/downloads/index.html)** +* **[Xcode](https://developer.apple.com/xcode/)**. Install it from the AppStore or from the **[Apple Developer Homepage](https://developer.apple.com/)**. +* Device with **tvOS 11.0 or newer** to install Kodi after build. + +Building for tvOS should work with the following combinations of Xcode and macOS versions: + * Xcode 12.4 against tvOS SDK 14.3 on 10.15.7 (Catalina)(recommended)(CI) + * Xcode 13.x against tvOS SDK 15.4 on 12.x (Monterey)(recommended) + +Team Kodi CI infrastructure is limited, and therefore we only have the single combination tested. Newer xcode/macos combinations generally should work, however the team does not actively test/use pre-release versions, so use with caution. Earlier versions may work, however we dont actively support them, so use with caution. +**WARNING:** Start Xcode after installation finishes. You need to accept the licenses and install missing components. + +**[back to top](#table-of-contents)** + +## 3. Get the source code +Change to your `home` directory: +``` +cd $HOME +``` + +Clone Kodi's current master branch: +``` +git clone https://github.com/xbmc/xbmc kodi +``` + +**[back to top](#table-of-contents)** + +## 4. Configure and build tools and dependencies +Kodi can be built as a 64bit program only for tvOS. The dependencies are built in `$HOME/kodi/tools/depends` and installed into `/Users/Shared/xbmc-depends`. +**NOTE:** `--with-platform` is mandatory for all Apple platforms + +Configure build: +``` +cd $HOME/kodi/tools/depends +./bootstrap +./configure --host=aarch64-apple-darwin --with-platform=tvos +``` + +Build tools and dependencies: +``` +make -j$(getconf _NPROCESSORS_ONLN) +``` + +**TIP:** By adding `-j<number>` to the make command, you can choose how many concurrent jobs will be used and expedite the build process. It is recommended to use `-j$(getconf _NPROCESSORS_ONLN)` to compile on all available processor cores. The build machine can also be configured to do this automatically by adding `export MAKEFLAGS="-j$(getconf _NPROCESSORS_ONLN)"` to your shell config (e.g. `~/.bashrc`). + +**WARNING:** Look for the `Dependencies built successfully.` success message. If in doubt run a single threaded `make` command until the message appears. If the single make fails, clean the specific library by issuing `make -C target/<name_of_failed_lib> distclean` and run `make`again. + +**NOTE:** **Advanced developers** may want to specify an tvOS SDK version (if multiple versions are installed) in the configure line(s) shown above. The example below would use the tvOS SDK 11.0: +``` +./configure --host=aarch64-apple-darwin --with-platform=tvos --with-sdk=11.0 +``` + +### 4.1. Advanced Configure Options + + +**All platforms:** + +``` +--with-toolchain=<path> +``` + specify path to toolchain. Auto set for android. Defaults to xcode root for darwin, /usr for linux + +``` +--enable-debug=<yes:no> +``` + enable debugging information (default is yes) + +``` +--disable-ccache +``` + disable ccache + +``` +--with-tarballs=<path> +``` + path where tarballs will be saved [prefix/xbmc-tarballs] + +``` +--with-cpu=<cpu> +``` + optional. specify target cpu. guessed if not specified + +``` +--with-linker=<linker> +``` + specify linker to use. (default is ld) + +``` +--with-platform=<platform> +``` + target platform + +``` +--enable-gplv3=<yes:no> +``` + enable gplv3 components. (default is yes) + +``` +--with-target-cflags=<cflags> +``` + C compiler flags (target) + +``` +--with-target-cxxflags=<cxxflags> +``` + C++ compiler flags (target) + +``` +--with-target-ldflags=<ldflags> +``` + linker flags. Use e.g. for -l<lib> (target) + +``` +--with-ffmpeg-options +``` + FFmpeg configure options, e.g. --enable-vaapi (target) + +**Apple Specific:** + +``` +--with-sdk=<sdknumber> +``` + specify sdk platform version. + +**[back to top](#table-of-contents)** + +## 5. Generate Kodi Build files +Before you can use Xcode to build Kodi, the Xcode project has to be generated with CMake. CMake is built as part of the dependencies and doesn't have to be installed separately. A toolchain file is also generated and is used to configure CMake. +Default behaviour will not build binary addons. To add addons to your build go to **[Add Binary Addons to Project](#52-Add-Binary-Addons-to-Project)** + +## 5.1. Generate XCode Project Files + +Before you can use Xcode to build Kodi, the Xcode project has to be generated with CMake. CMake is built as part of the dependencies and doesn't have to be installed separately. A toolchain file is also generated and is used to configure CMake. + +Create an out-of-source build directory: +``` +mkdir $HOME/kodi-build +``` + +Generate Xcode project for TVOS: +``` +make -C tools/depends/target/cmakebuildsys BUILD_DIR=$HOME/kodi-build +``` + +**TIP:** BUILD_DIR can be omitted, and project will be created in $HOME/kodi/build +Change all relevant paths onwards if omitted. + +Additional cmake arguments can be supplied via the CMAKE_EXTRA_ARGUMENTS command line variable + +An example to set signing settings in xcode project: +```` +make -C tools/depends/target/cmakebuildsys CMAKE_EXTRA_ARGUMENTS="-DPLATFORM_BUNDLE_IDENTIFIER='tv.kodi.kodi' -DCODE_SIGN_IDENTITY='iPhone Developer: *** (**********)' -DPROVISIONING_PROFILE_APP='tv.kodi.kodi' -DPROVISIONING_PROFILE_TOPSHELF='tv.kodi.kodi.Topshelf'" +```` +Available Signing arguments + +PLATFORM_BUNDLE_IDENTIFIER - bundle ID (used for the app, top shelf and entitlements) +DEVELOPMENT_TEAM - dev team ID **OR** CODE_SIGN_IDENTITY - certificate name +PROVISIONING_PROFILE_APP - provprofile name for the app +PROVISIONING_PROFILE_TOPSHELF - provprofile name for the top shelf + +## 5.2. Add Binary Addons to Project + +**TIP:** If you wish to add signing settings automatically, look at **[Generate XCode Project Files](#51-Generate-XCode-Project-Files)** for the additional `CMAKE_EXTRA_ARGUMENTS` + +You can find a complete list of available binary add-ons **[here](https://github.com/xbmc/repo-binary-addons)**. + +Binary addons will be built as a dependency in the Xcode project. You can choose the addons you wish to build during the Xcode project generation step + +Generate Xcode project to build specific add-ons: +``` +make -C tools/depends/target/cmakebuildsys CMAKE_EXTRA_ARGUMENTS="-DENABLE_XCODE_ADDONBUILD=ON -DADDONS_TO_BUILD='audioencoder.flac pvr.vdr.vnsi audiodecoder.snesapu'" +``` + +Generate Xcode project to build a specific group of add-ons: +``` +make -C tools/depends/target/cmakebuildsys CMAKE_EXTRA_ARGUMENTS="-DENABLE_XCODE_ADDONBUILD=ON -DADDONS_TO_BUILD='pvr.*'" +``` +For additional information on regular expression usage for ADDONS_TO_BUILD, view ADDONS_TO_BUILD section located at [Kodi add-ons CMake based buildsystem](../cmake/addons/README.md) + +Generate Xcode project to build all add-ons automatically: +``` +make -C tools/depends/target/cmakebuildsys CMAKE_EXTRA_ARGUMENTS="-DENABLE_XCODE_ADDONBUILD=ON" +``` + +**TIP:** If you wish to not automatically build addons added to your xcode project, omit `-DENABLE_XCODE_ADDONBUILD=ON`. The target will be added to the project, but the dependency will not be set to automatically build +**TIP:** Binary add-ons added to the generated Xcode project can be built independently of the Kodi app by selecting the scheme/target `binary-addons` in the Xcode project. +You can also build the binary-addons target via xcodebuild. This will not build the Kodi App, but will build any/all binary addons added for the project Generation. +``` +xcodebuild -config "Debug" -target binary-addons +``` +**[back to top](#table-of-contents)** | **[back to section top](#5-Generate-Kodi-Build-files)** + +## 6. Build + +### 6.1. Build with Xcode + +Start Xcode, open the Kodi project file created in **[Generate Kodi Build files](#5-Generate-Kodi-Build-files)** + +**TIP:** (`kodi.xcodeproj`) is located in `$HOME/kodi-build` + +Once the project has loaded, select `Generic TvOs Device` (or your actual connected device if you have it connected) and hit `Build`. + +This will create a `Kodi.app` file located in `$HOME/kodi-build/build/Debug-appletvos`. This App can be deployed via Xcode to an AppleTV via `Window -> Devices and Simulators -> Select device and click +` + +**TIP:** If you build as a release target, the location of the `Kodi.app` will be `$HOME/kodi-build/build/Release-appletvos` + +**WARNING:** If you have selected a specific tvOS SDK Version in step 4 then you might need to adapt the active target to use the same tvOS SDK version, otherwise build will fail. Be sure to select a device configuration. +**WARNING:** Building for simulator is NOT supported. + +### 6.2. Build with xcodebuild +Alternatively, you can also build via Xcode from the command-line with `xcodebuild`, triggered by CMake: + +Change to build directory: +``` +cd $HOME/kodi-build +xcodebuild -config "Debug" -jobs $(getconf _NPROCESSORS_ONLN) +``` + +This will create a `Kodi.app` file located in `$HOME/kodi-build/build/Debug-appletvos`. This App can be deployed via Xcode to an AppleTV via `Window -> Devices and Simulators -> Select device and click +` + +**TIP:** You can specify Release instead of Debug as -config parameter. +**TIP:** If you build as a release target, the location of the `Kodi.app` will be `$HOME/kodi-build/build/Release-appletvos` + +**[back to top](#table-of-contents)** | **[back to section top](#6-Build)** + +## 7. Packaging to distribute as deb +CMake generates a target called `deb` which will package Kodi ready for distribution. After Kodi has been built, the target can be triggered by selecting it in Xcode active scheme or manually running + +## 7.1. Package via Xcode + +Start Xcode, open the Kodi project file created in **[Generate XCode Project Files](#51-Generate-Project-Files)** + +**TIP:** (`kodi.xcodeproj`) is located in `$HOME/kodi-build` + +Click on `Product` in the top menu bar, and then go to `Scheme`, then select `deb` + +Hit `Build` + +**TIP:** The generated package will be located at $HOME/kodi-build/tools/darwin/packaging/tvos. + +## 7.2. Package via Xcodebuild + +Change to build directory: +``` +cd $HOME/kodi-build +xcodebuild -target deb +``` + +**TIP:** The generated package will be located at $HOME/kodi-build/tools/darwin/packaging/tvos. + +**[back to top](#table-of-contents)** + +## 8. Signing + +**TIP:** If your device is jailbroken, you can go direct to **[Installing on Jailbroken Device](#91-Jailbroken-devices)** + +## 8.1. Signing using a developer account + +For this to work you need to alter the Xcode project by setting your codesign identity or supplying credentials during +xcode generation. +Note that using a free developer account the signing will need to be reapplied every 7 days. + + 1. Open the Xcode project in Xcode as above (requires Xcode 7 or later) + 2. Select Xcode->Preferences and select Accounts + * Hit the + sign to add an Apple ID account and Login. + 2. Next select the kodi build target + 3. Under the `General` tab, enter a unique bundle identifier and check the box to `Automatically Manage Signing`. + 4. Select your team under `Automatically Manage Signing`. + +## An important note on Code Signing +It's also important that you select the signing on all 4 spots in the project settings. After the last buildstep, our support script will do a full sign of all binaries and bundle them with the given identity, including all the `*.viz`, `*.pvr`, `*.so`, etc. files Xcode doesn't know anything about. This should allow you to deploy Kodi to all non-jailbroken devices the same way you deploy normal apps to. +In that case Kodi will be sandboxed like any other app. All Kodi files are then located in the sandboxed *Documents* folder and can be easily accessed via iTunes file sharing. + +## 8.2. Using iOS App Signer to install + + 1. Build the deb target via xcodebuild or Xcode as per **[Build Kodi](#6-build-kodi)** + 2. Open iOS Appsigner + 3. Browse to $HOME/kodi/build/tools/darwin/packaging/tvos for your input file + 4. Select your signing certificate + 5. Select your provisioning profile + 6. Click start and select save location for the ipa file + 7. Run Xcode -> Window -> Devices and Simulators + 8. Select your Apple TV you setup in earlier for Wireless connecting press the + + 9. Find your ipa file and click open. + +**[back to top](#table-of-contents)** + +## 9. Install + +There are a number of different methods that can be used to install kodi on an AppleTV 4/4K. + +## 9.1. Jailbroken devices +On jailbroken devices the resulting deb file created from **[Packaging to distribute as deb](#7-Packaging-to-distribute-as-deb)** can be copied to the tvOS device via *ssh/scp* and installed manually. You need to SSH into the tvOS device and issue: +``` +dpkg -i <name of the deb file> +``` + +## 9.2. Using Xcode to install + +Whether you have paid or free developer account you can deploy Kodi via Xcode to work on a non-jailbroken devices. + +## Wirelessly connecting to AppleTV 4/4K +The Apple TV 4K cannot be connected to mac via a cable so the connection must be wireless to XCode to add the application. + + 1. Make sure your Mac and your Apple TV are on the same network. + 2. Choose `Window->Devices and Simulators`, then in the window that appears, click Devices. + 3. On your Apple TV, open the Settings app and choose `Remotes and Devices->Remote App and Devices`. + 4. The Apple TV searches for possible devices including the Mac. (If you have any Firewall or Internet security, disable/turn off to allow searching.) + 5. On your Mac, select the Apple TV in the Devices pane. The pane for the Apple TV is displayed and shows the current status of the connection request. + 6. Enter the verification code displayed on your AppleTV into the Device window pane for the device and click Connect. + +Xcode sets up the Apple TV for wireless debugging and pairs with the device. +Once your Apple TV has been connected in Xcode, you can deploy either the **[Deb](#7-Packaging-to-distribute-as-deb)** or **[App](#6-Build file)** file. + + 1. Choose Window > Devices and Simulators, then in the window that appears, click Devices. + 2. On your Mac, select the Apple TV in the Devices pane. + 3. Click the + symbol under `installed apps` and navigate to and select: `$HOME/kodi-build/build/Debug-appletvos/Kodi.app` and then `Open`. + +**[back to top](#table-of-contents)** diff --git a/docs/codeofconduct/CodeOfConduct.md b/docs/codeofconduct/CodeOfConduct.md new file mode 100644 index 0000000..856ed56 --- /dev/null +++ b/docs/codeofconduct/CodeOfConduct.md @@ -0,0 +1,196 @@ +# **Code of Kodi** + +## **Introduction:** + +- This document should hopefully be entirely common sense and how most + people would normally act anyway. +- In an ideal world it would be entirely unnecessary, but with the impersonal + nature of internet communications and with differing viewpoints on certain + sensitive topics, some guidelines have proven to be necessary at times. + +## **Our Aims:** + +- Our primary aim is to make Kodi the best open source media player + product that it can be. + +- To achieve this, we aim to create a supportive, welcoming and + open team environment where anyone can participate and submit code or + time/knowledge to help improve things. + +- Our team environment should be welcoming and safe, free of + harassment, discrimination and undesirable behaviour to individual + or groups of members. + +- Whilst we do not expect everyone to get along and agree all of the + time, we do expect people to be civil and professional to one + another. + +## **Our Expectations:** + +1. Contributions from anyone are welcome, and should be encouraged. + Where criticism or correction is needed, try to make it respectful, + constructive, supportive and positive. + +1. Contributors should act in the best interest of the community and of + the Kodi project. + +1. We're all volunteers -- people will give whatever time and effort + they wish to. No-one should be made to do anything they don't want + to. + +1. Discrimination, harassment, threatening/bullying behaviour, trolling + or insulting/derogatory language will not be tolerated in any form + via any Kodi channel or site. + +1. Respect the contribution and efforts of others -- treat them as + you'd like them to treat you. + +1. Publication and sharing of confidential information, both relating + to Kodi and to individual's personal data, is only by explicit permission + of the relevant information owner and person(s) concerned, as applicable. + +1. Work on Kodi is a team effort. + Individual contributions are highly appreciated and to be respected, + but they do not empower those contributors to make decisions + affecting the overall management of the project. + +1. If you are a team member, you may have the title of "Team Kodi Member" + (or variants thereof) in environments like the Kodi forum. You are of + course free to state your own opinions on topics, but for more + controversial ones, please ensure to explicitly state that what you + post is your own opinion and not that of the team or the project. + +1. Discussions, debate and disagreement are a natural part of a working + team. Account should be taken though for the impersonal nature of + internet discussions, and for things like language and cultural + norms. Don't be too quick to assume ill intent or to take offense, + and respect people's boundaries and feelings. + +1. Where you can, be helpful to fellow contributors and share your + knowledge and skills. We all have to start somewhere, and they may + be able to return the favour later or contribute more fully as a + result. + +1. No-one is perfect -- tolerate honest mistakes that may be made, + learn from them and help to repair them when you can. And if they're + yours, be honest about them and apologise. + +1. Submitted code and other important documentation will be peer + reviewed. Comments, suggestions and constructive criticism should be + taken with good grace and not as a slight or insult to the work and + effort put in. + +1. There is an over-riding principle that accepted work, postings or commits + should not be reverted, edited or otherwise rejected without discussion + with the original author. + + Recognising that changes do sometimes need to be made (for example, code + commits which break master compilation or simple typos that shouldn't be + left and forgotten), a reasonable attempt - reflecting the spirit of the + change/reversion - should be made to liaise with the original author prior + to making any modifications. If this isn't practical, it is considered good + practice to appropriately peer review any potential changes prior to + application to minimise risks of further breakage. + +1. In case of dispute the working group or the board should be asked + to mediate. + +## **Scope:** + +- This code covers all services supplied by and used by Team Kodi, + such as: + + - The official GitHub repos. + + - The Kodi forum. + + - The Kodi wiki. + + - The Kodi Slack and IRC channels. + + - Official Kodi social media channels. + + - Devcon. + +- Anyone who contributes to the Kodi project on any of these channels + is expected to abide by this code. + +## **Enforcement:** + +- Violations of this code which cannot be dealt with by simple + discussion should be reported to the working group via conduct@kodi.tv . + The group will then review the issue and mediate between the parties involved. + +- The identity of the reporter and where appropriate the nature of the issue + should remain confidential and be handled with care and sensitivity. + +- The procedure upon receiving a report should be: + + 1. The group should review the report, and any member directly + involved or having a vested interest in the outcome should + recuse themselves. + + 1. Any public disputes or discussions should be brought to a close + with a clear statement that the issue is under review, and that + any further 3rd party comment should be directed to the group + via the group email address. + + 1. All individuals concerned with the issue will be contacted + privately and an attempt made to clarify their individual + viewpoints and concerns. Particular emphasis on identifying and + resolving any misunderstandings, mistranslations or + misinterpretations will be made. + + 1. In case of such identifications, the group will attempt to + mediate between the parties involved to resolve the problem if + possible. + + 1. The behaviour of all parties involved will be reviewed, and in + cases where the code has been broken (e.g. harassment, + discrimination or aggression) further action will be discussed + against the individual(s) concerned. + + 1. This action will depend on the severity of the transgression and + on the history of the individual. Some guidelines for + appropriate measures for team members are: + + - First offence -- a warning. + + - Second offence -- loss of privileges for a week. + + - Third offence -- loss of privileges for a month. + + - Fourth offence -- permanent revoking of privileges. + + - Final offence -- banning from all Kodi services. + + - Privileges will depend on the nature of the issue, but may + include team membership, GitHub repo push access, forum + moderator powers, wiki account access and social media + account access. + + For individuals that are not members of Team Kodi, there are no + privileges that could be revoked. Appropriate measures therefore + include warnings and revoking access to services such as the + forum or the `xbmc` organization on GitHub temporarily or + permanently. + +## **Stakeholders:** + +- *Kodi Foundation Board* -- the elected five directors and management + of the XBMC Foundation. + +- *Working Group* -- the team assigned by the board to create this + document and to oversee its administration. + +- *Contributors* -- volunteers who give input into the upkeep and + improvement of Kodi and its community, be they Team Members or + interested third parties. This includes both code and posts made to + the forum, the wiki or on official social media channels. + +## **Related Documents:** + +- [Forum rules](https://kodi.wiki/view/Official:Forum_rules) +- [Moderation rules (the basics)](https://github.com/xbmc/xbmc/blob/master/docs/codeofconduct/ModerationRules.md) +- [Moderator guidelines](https://github.com/xbmc/xbmc/blob/master/docs/codeofconduct/ModeratorGuidelines.md) +- [Forum banning code of conduct](https://github.com/xbmc/xbmc/blob/master/docs/codeofconduct/ForumUserBanning.md)
\ No newline at end of file diff --git a/docs/codeofconduct/ForumUserBanning.md b/docs/codeofconduct/ForumUserBanning.md new file mode 100644 index 0000000..8921bee --- /dev/null +++ b/docs/codeofconduct/ForumUserBanning.md @@ -0,0 +1,15 @@ +Originally posted by DarrenHill on the forum + +From discussions earlier on the slack team channel and following on from recent events, I was asked to propose a code of conduct for bans and user banning on the forum, to be followed by all with moderator powers. + +1. When required and when the case is clear, spambots and spam accounts should be dealt with using the "Goodbye Spammer" moderator tool. However if the user/post is not 100% certainly spam, then a second opinion must be sought on the slack #moderator channel as once GBS is used, it cannot be undone. + +2. For users repeatedly asking for support for banned add-ons or those ignoring warnings or legitimate moderator requests then the normal "three strikes" rule should be applied, with an official warning after the second strike and a short ban (up to one week) applied after the third strike. + +3. Where users are being abusive, aggressive or otherwise in violation of the forum rules, warnings should be given when possible, but if a ban is necessary then a second opinion must be obtained, unless the ban is very temporary, 3 days or less, with the explicitly stated reason of cooling heads. This second opinion may be obtained either on the slack channel or by using the forum report post feature with the request that another moderator review the situation and take action if they agree it necessary. Lengthy bans (anything over 3 months) should be done as a team decision. Each ban from this section, whether long or short, shall include a note explaining the reason for the ban so that there is no confusion later. + +4. If you are personally involved with the issue under discussion, or if there are any other conflicts of interest which may prejudice fair and judicial usage of moderator powers, then you have to avoid any direct involvement beyond highlighting the problem to the moderator team. + +5. Normally if a ban is to be lifted or modified it should be done by the original moderator who imposed the ban. But if the situation requires it, the ban may be reviewed by the moderator team as a whole, and if the majority decides that a change or revoke is required then the change may be made (and no further changes made without a second discussion). + +This code applies to all users with moderator powers on the board, and must be followed by them. At the moderator team's discretion, failure to do so may result in suspension or removal of such powers for a period of initially a week, with longer periods considered for more serious issues.
\ No newline at end of file diff --git a/docs/codeofconduct/ModerationRules.md b/docs/codeofconduct/ModerationRules.md new file mode 100644 index 0000000..2ad7b77 --- /dev/null +++ b/docs/codeofconduct/ModerationRules.md @@ -0,0 +1,30 @@ +Moderation Rules - Originally posted by Kib on the forum. + +With great power comes great responsibility, and it is important to not misuse the power we have received. +Below are a set of basic rules for the forum moderation that we have come up with. +In case a rule is missing that you think should be added, feel free to discuss. + +**Writing posts or replies** +- Be civil, no matter how infuriating other persons are. +- Unsure what to do? Ask a fellow moderator or the team in this forum! + +**Editing posts** +- Never edit posts without explaining that you did so in your edit. +- Editing to remove harmful content is OK. +- Editing broken links or confusing misspelling to fix them is OK +- Editing posts because you do not agree with what was said, is NOT ok. + +**Deleting posts or whole threads** +- Don't. It's much more preferred to move them to the garbage or edit the offending bits out (See above) +- For spam: use the stopforumspam link in the top right of the post, or ask an admin when that is not possible. + +**Moving threads** +- When moving threads, when possible leave a non-permanent redirect for a number of days. 7 is a good number, but 3 works as well. Use your own intuition. Wink +- Reply to the thread stating that you moved it, ergo "Moved to support section because this does not belong in Android development" + +**Sticking / Unsticking threads** +- When in doubt, don't stick or unstick +- Only sticky threads that will be valid for a long time. +- Do not sticky many threads, it gets in the way of browsing the forum +- If many threads are stickied, it is usually better to consolidate the information by making a reference sticky that points to all the threads +- Contact the author before unstickying threads
\ No newline at end of file diff --git a/docs/codeofconduct/ModeratorGuidelines.md b/docs/codeofconduct/ModeratorGuidelines.md new file mode 100644 index 0000000..7a6ef04 --- /dev/null +++ b/docs/codeofconduct/ModeratorGuidelines.md @@ -0,0 +1,54 @@ +Moderator Guidelines - originally posted on the forum by DarrenHill + +As suggested by keith on the slack channel, I thought it might be useful to have a few notes and suggestions for how to moderate around here, especially as we have several new members of the team recently. So below are my thoughts on it - please feel free to add to the thread any additional ones that you may have (or that you may disagree with in mine). + +**General stuff:** +- Above all else, try to stay calm and not get emotionally involved. Moderating whilst angry, upset or similar (or drunk etc) can often lead to making situations worse rather than better. +- If you're ever in doubt, take a few moments to check stuff out, or ask for support on the slack channel or this section. We're a moderator team, not a bunch of individuals. +- Don't be too quick to attribute stuff to malice or deviousness that can be accounted for by simple stupidity or ignorance. +- If you do something to a thread or post, make it clear what you have done by adding a note or a new post to it. This includes moving threads and splitting/merging them or chopping posts out for binning. +- All actions performed are recorded in the moderator logs. +- Support one another, and those users who are kind enough to flag up posts and thread (either by the report system or via posts in threads) that may need action. +- Super Moderators (and many Team Kodi members) have mod powers everywhere, whilst normal Moderators have the same powers but in more restricted areas of the forum. + +- We do not support any installation containing banned add-ons, with the exception of assisting users in removal of them. If the thread is asking about them directly, then bin it. But if it's more tangential (e.g. evidence in a debug log) then inform the user of their presence and that this precludes any support, but leave the thread open to allow them to react and hopefully be educated about it (binning via the delayed moderation tools can be useful here as well). You can also redirect them to JJD-UK's new sticky threads about such add-ons. +- If you do something right, most people won't notice. But if you do something wrong, don't be surprised if certain of our membership take it upon themselves to give you grief. Don't take it personally, it's a thankless task sometimes (and flameproof Kodi-branded underwear is optional). +- Make use of the wiki, and pages like the forum rules, the banned add-ons list, the Official:Trademark Policy and the notes for the first time user. Also Nate's blog post and Martijn's blog post are both useful educational readings for our more naïve users. +- If an action has been performed by another moderator or team member that you do not agree with, please consult with them on slack or here about it for clarification and discussion. Do not arbitrarily undo actions by other mods without doing so. Whilst everyone makes mistakes sometimes, there may be more to it than initially appears. + +**Moderator tools** +- All of the mod tools except goodbye spammer are accessible via the drop-down menu at the bottom-right of your web browser (can't comment about tapatalk as I don't use it, but I think it's more limited). +- If you're on Tapatalk and need something done that you can't do directly, just use the report function, make a thread/post here or ask on slack. +- If you're not sure what a tool does or how it works, ask either on slack or here. And if necessary, make a new thread or two in the garbage section and practice with them on how to split/merge threads etc and how to bin stuff. +- With the exception of "goodbye spammer" and thread/post deletion actions, there's no moderator tool action that cannot be undone again. +- Except for spam posts, always use the garbage section (via the tools to "move to garbage" or "move to spam & rule violation") rather than permanently deleting. +- The "move to garbage" and "move to spam & rule violation" are your most commonly used tools. Both move the thread to the bin and automatically close (lock) it. The only differences are the automatic post that is added to the thread, and that "move to garbage" leaves a redirect whereas "spam & violation" doesn't. +- If you do bin a thread, try to add a post to it first explaining why you're doing so. + +- Obvious spam post accounts should be dealt with via the "goodbye spammer" tool (the yellow warning triangle on the right hand side of the post). Note that this (after a confirmation screen) deletes the account, IP blocks its source and removes permanently all posts/threads made by that account. It is permanent and cannot be (easily) undone. +- Goodbye spammer can only be used on users with less than 30 posts. If a spambot has been particularly verbose and exceeded that, you may need to delete a number of their threads manually to bring the count below this so that it can be used. Note this is one of the few cases where thread permanent deletion should be used, as just binning the threads won't bring the count down to re-enable goodbye spammer. +- If you're not sure if a post/account is spam or not, consult with the team and also try a Google (or other engine) search. Spambot posts get spider-scraped and will show up in searches, making multi-site spambots obvious. +- Delayed moderation actions (the first option in the drop-down menu) can be useful for times when you may want to perform an action later (e.g. close a thread temporarily now and then use a delayed moderation action to reopen it at a later time without having to remember then to go and do so. + +**Housekeeping** +- Moving threads between sections is one of the most common jobs. Not glamorous, but it is needed. +- If you move a thread (via the move/copy thread tool), generally it's best to leave a redirect (the default option when you select the tool) so the users can still find it. Personally I use 7 days duration for all except the discussions section where I use 3, but it's a matter of personal taste. If you don't set anything, the redirect shortcut will stay forever. +- Also if you move a thread, leave a note in it to say that you've done so. +- Discussions isn't for support requests - that's what the main support sections are for. +- Threads moved to off-topic can still be posted to by anyone, but normal users cannot start threads in that section. +- If you bin a thread that contains dodgy links, please remember to edit it and remove them. The bin is publicly visible, so can be harvested for such things by enterprising idiots. + +**Warnings and banning** +- Banning someone is an extreme measure, and should only be done "off the cuff" for short-term duration (certainly no more than a 2 week ban, ideally less) as a direct result of threatening or insulting behaviour (for the latter, something that goes materially beyond a simple breach of 2.1 of the Forum Rules). +- Any longer ban should only be made after discussion (on Slack) with at least one other moderator. +- Consider also the seniority/contribution of the person in question, and thus the proportionality of the penalty. +- While this is not a democracy, we do value our users and owe them some degree of transparency as to our actions. As such, warnings should be used where possible before bans are actioned (although of course that is not always feasible if a user needs removing quickly). +- Where possible, warnings should be used before bans are actioned (the "3 strikes" rule, although of course that is not always feasible if a user needs removing quickly). +- Both can be done either via the buttons below posts or via the profile page of the user. +- Warnings can be set to anything from 10% to 100% (click the "custom reason" button in the warning page to access that, the "points" setting is per 10% so 4 points is 40%). In that page you also put information that will be seen by the user as to what the reason for the warning is, and how long it will last. +- Note that all a warning does practically is increase the figure visible below the user avatar beside posts. A 100% warning does not trigger any other action automatically, it's basically cosmetic. +- Bannings work in a similar fashion, but of course actually deny the user account access to being able to log into the forum. They can be set for anything from 1 hour to a permanent ban. +- Note that banning does not block IP addresses (although admins here can do that if necessary), but the creation of a second account to get around a ban is itself a forum rules violation and can be cause for such an IP block. +- It is possible to reverse both warnings and bans, but do not do so without consulting and discussing with the moderator or team member who initially applied them. + +I would hope most of the above is obvious, plus I'm sure there are bits that should be there but I've forgotten. But please feel free to add to the suggestions and guidelines so we can do things consistently and well across the whole team and forum.
\ No newline at end of file diff --git a/docs/doxygen/Doxyfile.doxy b/docs/doxygen/Doxyfile.doxy new file mode 100644 index 0000000..b0e0859 --- /dev/null +++ b/docs/doxygen/Doxyfile.doxy @@ -0,0 +1,2474 @@ +# Doxyfile 1.8.11 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +# This includes a own file where used on Kodi itself and by kodi-dev-kit. +# Also used to have on new releases better overview which parts need update. +@INCLUDE = ./kodi_values.doxy + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Kodi Documentation" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +# PROJECT_NUMBER done by ./kodi_values.doxy + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Kodi is an open source media player and entertainment hub." + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = Thumbnail-symbol-whitebg-small.jpg + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = ../ + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = YES + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 2 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +# ALIASES done by ./kodi_values.doxy + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if <section_label> ... \endif and \cond <section_label> +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ../../xbmc \ + ../CODE_GUIDELINES.md \ + . + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, +# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.d \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.idl \ + *.odl \ + *.cs \ + *.php \ + *.php3 \ + *.inc \ + *.m \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.vhd \ + *.vhdl + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = */*Codec/* \ + doxygen.hpp + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# <filter> <input-file> +# +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = NO + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = NO + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use <access key> + S +# (what the <access key> is depends on the OS and browser, but it is typically +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down +# key> to jump into the search results window, the results can be navigated +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel +# the search. The filter options can be selected when the cursor is inside the +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> +# to select a filter and <Enter> or <escape> to activate or cancel the filter +# option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a web server instead of a web client using Javascript. There +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SERVER_BASED_SEARCH = NO + +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the +# search results. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: http://xapian.org/). +# +# See the section "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will return the search results when EXTERNAL_SEARCH is enabled. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: http://xapian.org/). See the section "External Indexing and +# Searching" for details. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. +# The default file is: searchdata.xml. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of +# to a relative location where the documentation can be found. The format is: +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# The default value is: YES. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. +# +# Note that when enabling USE_PDFLATEX this option is only used for generating +# bitmaps for formulas in the HTML output, but not in the Makefile that is +# written to the output directory. +# The default file is: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate +# index for LaTeX. +# The default file is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used by the +# printer. +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x +# 14 inches) and executive (7.25 x 10.5 inches). +# The default value is: a4. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names +# that should be included in the LaTeX output. The package can be specified just +# by its name or with the correct syntax as to be used with the LaTeX +# \usepackage command. To get the times font for instance you can specify : +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} +# To use the option intlimits with the amsmath package you can specify: +# EXTRA_PACKAGES=[intlimits]{amsmath} +# If left blank no extra packages will be included. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the +# generated LaTeX document. The header should contain everything until the first +# chapter. If it is left blank doxygen will generate a standard header. See +# section "Doxygen usage" for information on how to let doxygen write the +# default header to a separate file. +# +# Note: Only use a user-defined header if you know what you are doing! The +# following commands have a special meaning inside the header: $title, +# $datetime, $date, $doxygenversion, $projectname, $projectnumber, +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty +# string, for the replacement values of the other commands the user is referred +# to HTML_HEADER. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the +# generated LaTeX document. The footer should contain everything after the last +# chapter. If it is left blank doxygen will generate a standard footer. See +# LATEX_HEADER for more information on how to generate a default footer and what +# special commands can be used inside the footer. +# +# Note: Only use a user-defined footer if you know what you are doing! +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_FOOTER = + +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the LATEX_OUTPUT output +# directory. Note that the files will be copied as-is; there are no commands or +# markers available. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_FILES = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will +# contain links (just like the HTML output) instead of page references. This +# makes the output suitable for online browsing using a PDF viewer. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate +# the PDF file directly from the LaTeX files. Set this option to YES, to get a +# higher quality PDF documentation. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode +# command to the generated LaTeX files. This will instruct LaTeX to keep running +# if errors occur, instead of asking the user for help. This option is also used +# when generating formulas in HTML. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BATCHMODE = NO + +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# index chapters (such as File Index, Compound Index, etc.) in the output. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HIDE_INDICES = NO + +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source +# code with syntax highlighting in the LaTeX output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. See +# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# The default value is: plain. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BIB_STYLE = plain + +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The +# RTF output is optimized for Word 97 and may not look too pretty with other RTF +# readers/editors. +# The default value is: NO. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: rtf. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will +# contain hyperlink fields. The RTF file will contain links (just like the HTML +# output) instead of page references. This makes the output suitable for online +# browsing using Word or some other Word compatible readers that support those +# fields. +# +# Note: WordPad (write) and others do not support links. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's config +# file, i.e. a series of assignments. You only have to provide replacements, +# missing definitions are set to their default value. +# +# See also section "Doxygen usage" for information on how to generate the +# default style sheet that doxygen normally uses. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an RTF document. Syntax is +# similar to doxygen's config file. A template extensions file can be generated +# using doxygen -e rtf extensionFile. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_EXTENSIONS_FILE = + +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code +# with syntax highlighting in the RTF output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# classes and files. +# The default value is: NO. + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. A directory man3 will be created inside the directory specified by +# MAN_OUTPUT. +# The default directory is: man. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to the generated +# man pages. In case the manual section does not start with a number, the number +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is +# optional. +# The default value is: .3. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_EXTENSION = .3 + +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it +# will generate one additional man file for each entity documented in the real +# man page(s). These additional files only source the real man page, but without +# them the man command would be unable to find the correct page. +# The default value is: NO. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that +# captures the structure of the code including all documentation. +# The default value is: NO. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: xml. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_OUTPUT = xml + +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program +# listings (including syntax highlighting and cross-referencing information) to +# the XML output. Note that enabling this will significantly increase the size +# of the XML output. +# The default value is: YES. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- + +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# that can be used to generate PDF. +# The default value is: NO. + +GENERATE_DOCBOOK = NO + +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in +# front of it. +# The default directory is: docbook. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_OUTPUT = docbook + +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the +# program listings (including syntax highlighting and cross-referencing +# information) to the DOCBOOK output. Note that enabling this will significantly +# increase the size of the DOCBOOK output. +# The default value is: NO. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_PROGRAMLISTING = NO + +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see http://autogen.sf.net) file that captures the +# structure of the code including all documentation. Note that this feature is +# still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module +# file that captures the structure of the code including all documentation. +# +# Note that this feature is still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI +# output from the Perl module output. +# The default value is: NO. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely +# formatted so it can be parsed by a human reader. This is useful if you want to +# understand what is going on. On the other hand, if this tag is set to NO, the +# size of the Perl module output will be much smaller and Perl will parse it +# just the same. +# The default value is: YES. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file are +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful +# so different doxyrules.make files included by the same Makefile don't +# overwrite each other's variables. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# C-preprocessor directives found in the sources and include files. +# The default value is: YES. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# in the source code. If set to NO, only conditional compilation will be +# performed. Macro expansion can be done in a controlled way by setting +# EXPAND_ONLY_PREDEF to YES. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then +# the macro expansion is limited to the macros specified with the PREDEFINED and +# EXPAND_AS_DEFINED tags. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES, the include files in the +# INCLUDE_PATH will be searched if a #include is found. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by the +# preprocessor. +# This tag requires that the tag SEARCH_INCLUDES is set to YES. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will be +# used. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that are +# defined before the preprocessor is started (similar to the -D option of e.g. +# gcc). The argument of the tag is a list of macros of the form: name or +# name=definition (no spaces). If the definition and the "=" are omitted, "=1" +# is assumed. To prevent a macro definition from being undefined via #undef or +# recursively expanded use the := operator instead of the = operator. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \ + DOXYGEN_SHOULD_USE_THIS \ + __cplusplus + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this +# tag can be used to specify a list of macro names that should be expanded. The +# macro definition that is found in the sources will be used. Use the PREDEFINED +# tag if you want to use a different macro definition that overrules the +# definition found in the source code. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will +# remove all references to function-like macros that are alone on a line, have +# an all uppercase name, and do not end with a semicolon. Such function macros +# are typically used for boiler-plate code, and will confuse the parser if not +# removed. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES tag can be used to specify one or more tag files. For each tag +# file the location of the external documentation should be added. The format of +# a tag file without this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where loc1 and loc2 can be relative or absolute paths or URLs. See the +# section "Linking to external documentation" for more information about the use +# of tag files. +# Note: Each tag file must have a unique name (where the name does NOT include +# the path). If a tag file is not located in the directory in which doxygen is +# run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a +# tag file that is based on the input files it reads. See section "Linking to +# external documentation" for more information about the usage of tag files. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in +# the class index. If set to NO, only the inherited external classes will be +# listed. +# The default value is: NO. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will be +# listed. +# The default value is: YES. + +EXTERNAL_GROUPS = YES + +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in +# the related pages index. If set to NO, only the current project's pages will +# be listed. +# The default value is: YES. + +EXTERNAL_PAGES = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of 'which perl'). +# The default file (with absolute path) is: /usr/bin/perl. + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to +# NO turns the diagrams off. Note that this option also works with HAVE_DOT +# disabled, but it is recommended to install and use dot, since it yields more +# powerful graphs. +# The default value is: YES. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see: +# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# You can include diagrams made with dia in doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. + +DIA_PATH = + +# If set to YES the inheritance and collaboration graphs will hide inheritance +# and usage relations if the target is undocumented or is not a class. +# The default value is: YES. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz (see: +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# Bell Labs. The other options in this section have no effect if this option is +# set to NO +# The default value is: NO. + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed +# to run in parallel. When set to 0 doxygen will base this on the number of +# processors available in the system. You can set it explicitly to a value +# larger than 0 to get control over the balance between CPU load and processing +# speed. +# Minimum value: 0, maximum value: 32, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NUM_THREADS = 0 + +# When you want a differently looking font in the dot files that doxygen +# generates you can specify the font name using DOT_FONTNAME. You need to make +# sure dot is able to find the font, which can be done by putting it in a +# standard location or by setting the DOTFONTPATH environment variable or by +# setting DOT_FONTPATH to the directory containing the font. +# The default value is: Helvetica. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of +# dot graphs. +# Minimum value: 4, maximum value: 24, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the default font as specified with +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set +# the path where dot can find it using this tag. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTPATH = + +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for +# each documented class showing the direct and indirect inheritance relations. +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a +# graph for each documented class showing the direct and indirect implementation +# dependencies (inheritance, containment, and class references variables) of the +# class with other documented classes. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for +# groups, showing the direct groups dependencies. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the +# class node. If there are many fields or methods and many nodes the graph may +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the +# number of items for each type to make the size more manageable. Set this to 0 +# for no limit. Note that the threshold may be exceeded by 50% before the limit +# is enforced. So when you set the threshold to 10, up to 15 fields may appear, +# but if the number exceeds 15, the total amount of fields shown is limited to +# 10. +# Minimum value: 0, maximum value: 100, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LIMIT_NUM_FIELDS = 10 + +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and +# collaboration graphs will show the relations between templates and their +# instances. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +TEMPLATE_RELATIONS = NO + +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to +# YES then doxygen will generate a graph for each documented file showing the +# direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDE_GRAPH = YES + +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are +# set to YES then doxygen will generate a graph for each documented file showing +# the direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. Disabling a call graph can be +# accomplished by means of the command \hidecallgraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable caller graphs for selected +# functions only using the \callergraph command. Disabling a caller graph can be +# accomplished by means of the command \hidecallergraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# hierarchy of all classes instead of a textual one. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the +# dependencies a directory has on other directories in a graphical way. The +# dependency relations are determined by the #include relations between the +# files in the directories. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. For an explanation of the image formats see the section +# output formats in the documentation of the dot tool (Graphviz (see: +# http://www.graphviz.org/)). +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order +# to make the SVG files visible in IE 9+ (other browsers do not have this +# requirement). +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and +# png:gdiplus:gdiplus. +# The default value is: png. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# +# Note that this requires a modern browser other than Internet Explorer. Tested +# and working are Firefox, Chrome, Safari, and Opera. +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make +# the SVG files visible. Older versions of IE do not have SVG support. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +INTERACTIVE_SVG = NO + +# The DOT_PATH tag can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the \dotfile +# command). +# This tag requires that the tag HAVE_DOT is set to YES. + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the \mscfile +# command). + +MSCFILE_DIRS = + +# The DIAFILE_DIRS tag can be used to specify one or more directories that +# contain dia files that are included in the documentation (see the \diafile +# command). + +DIAFILE_DIRS = + +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file. If left blank, it is assumed +# PlantUML is not used or called during a preprocessing step. Doxygen will +# generate a warning when it encounters a \startuml command in this case and +# will not generate output for the diagram. + +PLANTUML_JAR_PATH = + +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes +# that will be shown in the graph. If the number of nodes in a graph becomes +# larger than this value, doxygen will truncate the graph, which is visualized +# by representing a node as a red box. Note that doxygen if the number of direct +# children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. +# Minimum value: 0, maximum value: 10000, default value: 50. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs +# generated by dot. A depth value of 3 means that only nodes reachable from the +# root by following a path via at most 3 edges will be shown. Nodes that lay +# further from the root node will be omitted. Note that setting this option to 1 +# or 2 may greatly reduce the computation time needed for large code bases. Also +# note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. +# Minimum value: 0, maximum value: 1000, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not seem +# to support this out of the box. +# +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# read). +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) support +# this, this feature is disabled by default. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# explaining the meaning of the various boxes and arrows in the dot generated +# graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot +# files that are used to generate the various graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_CLEANUP = YES diff --git a/docs/doxygen/README.md b/docs/doxygen/README.md new file mode 100644 index 0000000..b4aee7d --- /dev/null +++ b/docs/doxygen/README.md @@ -0,0 +1,5 @@ + + +# Kodi's Doxygen Documentation +To generate Kodi's doxygen documentation, run `doxygen Doxyfile.doxy` in this directory. Generated documentation will be located a directory level up (docs) inside `html`. + diff --git a/docs/doxygen/Thumbnail-symbol-whitebg-small.jpg b/docs/doxygen/Thumbnail-symbol-whitebg-small.jpg Binary files differnew file mode 100644 index 0000000..9375b6f --- /dev/null +++ b/docs/doxygen/Thumbnail-symbol-whitebg-small.jpg diff --git a/docs/doxygen/kodi_values.doxy b/docs/doxygen/kodi_values.doxy new file mode 100644 index 0000000..d17f670 --- /dev/null +++ b/docs/doxygen/kodi_values.doxy @@ -0,0 +1,34 @@ +PROJECT_NUMBER = 20.0 + +ALIASES = "table_start=<table width=\"100%\" style=\"border\" bgcolor=\"576f9f\" border=\"0\">" \ + "table_end=</table>" \ + "table_h2_l{2}=<tr bgcolor= 576f9f><th width= 40% align=left>\1</th><th width= 60% align=left>\2</th></tr>" \ + "table_row2_l{2}=<tr bgcolor=white><td width= 40% align=left>\1</td><td width= 60% align=left>\2</td></tr>" \ + "table_h3{3}=<tr bgcolor=576f9f><th width=30% align=left valign=middle><b>\1</b></th><th width=10% align=left valign=middle><b>\2</b></th><th width=60% align=left valign=middle><span><b>\3</b></span></th></tr>" \ + "table_row3{3}=\htmlonly<tr bgcolor=white><td width= 30% align=left>\endhtmlonly\1\htmlonly</td><td width= 10% align=left>\endhtmlonly\2\htmlonly</td><td width= 60% align=left>\endhtmlonly\3\htmlonly</td></tr>\endhtmlonly" \ + "python_func{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Function: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4><hr> \endhtmlonly" \ + "python_func_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Function: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style=\"float:right;\"><small>\2</small></span></h4> \endhtmlonly" \ + "python_class{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \ + "python_class_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style=\"float:right;\"><small>\2</small></span></h4> \endhtmlonly" \ + "python_removed_function{3}=\htmlonly <dl class=\"reflist\"><dt>Member <a class=\"el\" href=\"\2\">\1</a> (...)</dt><dd>\3</dd></dl>\endhtmlonly" \ + "cpp_class{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \ + "cpp_namespace{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Namespace: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \ + "doc_header{1}=\htmlonly <h3><span style=\"text-decoration: underline;\"><span style=\"font-style: italic;\"><span style=\"color: rgb(102, 102, 102);\">\1</span></span></span></h3> \endhtmlonly" \ + "python_v12=\xrefitem python_v12 \"v12 Python API changes\" \"\"" \ + "python_v13=\xrefitem python_v13 \"v13 Python API changes\" \"\"" \ + "python_v14=\xrefitem python_v14 \"v14 Python API changes\" \"\"" \ + "python_v15=\xrefitem python_v15 \"v15 Python API changes\" \"\"" \ + "python_v16=\xrefitem python_v16 \"v16 Python API changes\" \"\"" \ + "python_v17=\xrefitem python_v17 \"v17 Python API changes\" \"\"" \ + "python_v18=\xrefitem python_v18 \"v18 Python API changes\" \"\"" \ + "python_v19=\xrefitem python_v19 \"v19 Python API changes\" \"\"" \ + "python_v20=\xrefitem python_v20 \"v20 Python API changes\" \"\"" \ + "skinning_v12=\xrefitem skinning_v12 \"v12 Skinning engine changes\" \"\"" \ + "skinning_v13=\xrefitem skinning_v13 \"v13 Skinning engine changes\" \"\"" \ + "skinning_v14=\xrefitem skinning_v14 \"v14 Skinning engine changes\" \"\"" \ + "skinning_v15=\xrefitem skinning_v15 \"v15 Skinning engine changes\" \"\"" \ + "skinning_v16=\xrefitem skinning_v16 \"v16 Skinning engine changes\" \"\"" \ + "skinning_v17=\xrefitem skinning_v17 \"v17 Skinning engine changes\" \"\"" \ + "skinning_v18=\xrefitem skinning_v18 \"v18 Skinning engine changes\" \"\"" \ + "skinning_v19=\xrefitem skinning_v19 \"v19 Skinning engine changes\" \"\"" \ + "skinning_v20=\xrefitem skinning_v20 \"v20 Skinning engine changes\" \"\"" diff --git a/docs/doxygen/pages/mainpage.dox b/docs/doxygen/pages/mainpage.dox new file mode 100644 index 0000000..18ba7e9 --- /dev/null +++ b/docs/doxygen/pages/mainpage.dox @@ -0,0 +1,229 @@ +/*! \file mainpage.dox + \brief Introduction page + + \mainpage Introduction + Welcome to the documentation of Kodi. This starting page is meant to help people find their + way around the code. + + This documentation is a work in progress - only some of the code has thus far been documented + and we welcome any and all input to documenting it further. Documentation serves both to help + newcomers get to grips with the source quickly, and to highlight possible deficiencies in the + code or interfaces. Due to the projects history you may find XBMC mentioned in the docs, this was + the previous name of the project. + + Any help/suggestions are more than welcome. + + \section doxy_whatisxbmc What is Kodi? + Kodi is a free, open source (GPL) multimedia player that runs on Linux, Mac OS X (10.4 and later), + Windows, IOS and Android. See http://kodi.tv for more details. +*/ + +// Groups definition + +/*! + \defgroup jobs Asynchronous jobs + Threaded job execution +*/ + +/*! + \defgroup guilib Guilib classes + Guilib classes +*/ + +/*! + \defgroup graphics Graphics and Screen + \ingroup guilib + + Everything around graphics and Screen +*/ + +^/*! + \defgroup thumbs Thumbs + \ingroup graphics + Everything around the thumbs +*/ + +/*! + \defgroup textures Textures and Fonts + \ingroup graphics + + Everything about textures and fonts +*/ + +/*! + \defgroup items Items + \ingroup guilib + Everything around items +*/ + +/*! + \defgroup labels Labels + \ingroup guilib + Everything around labels +*/ + +/*! + \defgroup lists Lists + \ingroup guilib + Everything around lists +*/ + +/*! + \defgroup strings Strings and Localization + \ingroup guilib + + Everything around Strings and localization +*/ + +/*! + \defgroup tinyxml XML Parser + \ingroup strings + Tiny XML - XML Parser +*/ + +/*! + \defgroup winref Window Reference + \ingroup guilib + The window reference +*/ + +/*! + \defgroup winmsg Windows and Messages + \ingroup winref + Windows and messages +*/ + +/*! + \defgroup controls Controls + \ingroup winref + Control classes +*/ + +/*! + \defgroup winman Window Manager and Callbacks + \ingroup winref + + Everything about window manager and callbacks +*/ + +/*! + \defgroup actionkeys Actions and Keys + \ingroup winref + + Everything around action mapping and key processing +*/ + +/*! + + \defgroup database Database + + Everything around the database +*/ + +/*! + \defgroup filesystem Filesystem + Everything around the filesystem +*/ + +/*! + \defgroup input Input + Everything around input +*/ + +/*! \defgroup keyboard Keyboard + \ingroup input + + Keyboard input is processed by \ref CInputManager and forwarded to + registered keyboard handlers (e.g. game clients) or as actions to the UI: + + - If no keyboard handlers are registered or if they don't consume events, + the keyboard events are forwarded to the UI via \ref CInputManager::OnKey. + - Clients (e.g. game clients implementing \ref KEYBOARD::IKeyboardHandler) call + \ref CInputManager::RegisterKeyboardHandler to register themselves as eligible + for keyboard input events. + - Keyboards can emulate Joysticks as described in KEYBOARD::CJoystickEmulation. +*/ + +/*! + \defgroup mouse Mouse + \ingroup input + Everything around mouse + + Mouse input is processed by \ref CInputManager and forwarded to + registered mouse handlers (e.g. game clients) or as actions to the UI: + + - If no mouse handlers are registered or if they don't consume events, + the mouse input events are forwarded to the UI via \ref CInputManager::ProcessMouse. + - Clients (e.g. game clients implementing \ref MOUSE::IMouseInputHandler) call + \ref CInputManager::RegisterMouseHandler to register themselves as eligible + for mouse input events. + - Mouse events (from \ref CInputManager::OnEvent) are collected via implementations of + \ref MOUSE::IMouseDriverHandler and transformed into higher level features by + \ref MOUSE::IMouseButtonMap instances before they are sent to the handlers. +*/ + +/*! + \defgroup joystick Joystick + \ingroup input + Everything around joystick +*/ + +/*! + \defgroup touch Touch + \ingroup input + Everything around touch detection +*/ + +/*! + \defgroup touch_generic Touch + \ingroup touch + Everything around generic touch detection +*/ + +/*! + \defgroup games + Everything about RetroPlayer. +*/ + +/*! + \defgroup interface Interfaces + Everything around interfaces +*/ + +/*! + \defgroup info Info + \ingroup interface + Everything around the info interface +*/ + +/*! + \defgroup jsonrpc JSON-RPC + \ingroup interface + Everything around the json-rpc interface +*/ + +/*! + \defgroup jsonrpc JSON-RPC + \ingroup interface + Everything around the json-rpc interface +*/ + +/*! + \defgroup listproviders Listproviders + Everything around the listproviders +*/ + +/*! + \defgroup music Music info + Elements used in my music +*/ + +/*! + \defgroup settings Settings + Everything around the settings +*/ + +/*! + \defgroup windows Windows + Kodi windows +*/ diff --git a/docs/manpages/kodi-TexturePacker.1 b/docs/manpages/kodi-TexturePacker.1 new file mode 100644 index 0000000..553625b --- /dev/null +++ b/docs/manpages/kodi-TexturePacker.1 @@ -0,0 +1,24 @@ +.TH TexturePacker 1 +.SH NAME +TexturePacker \- Compile all images used in a XBMC / Kodi skin into a single file +.SH SYNOPSIS +.B TexturePacker +[\fB\-dupecheck\fR] +[\fB\-\-input\fR \fIDIRECTORY\fR] +[\fB\-\-output\fR \fIFILE.xbt\fR] +.SH DESCRIPTION +Kodi uses a tool named TexturePacker to compile all images used in a skin into a single file. The benefit of it is that images inside the Textures.xbt will load faster in the skin. This is done by converting all images into a format that take less processing by Kodi when they need to be rendered onto the screen. + +A common misconception is that TexturPacker will just compress the images into a single file. This if far from the truth, so don't be surprised if the Textures.xbt file is much larger than the total size of all the individual images. + +The optional -dupecheck option is useful if you have included the same image multiple times in your media folder. For example, if your skin includes a lot of studio logos, most likely a lot of them are included multiple times but with a slightly different filename. The '-dupecheck' option will make sure each unique image is included only once in the Textures.xbt file, thus keeping the size of it as small as possible. +.SH OPTIONS +.TP +.BR \-dupecheck +Check for image duplicates first +.TP +.BR \-input +fully-qualified name of input directory with images +.TP +.BR \-output +fully-qualified name of resulting compressed XBT file diff --git a/docs/manpages/kodi-ps3remote.1 b/docs/manpages/kodi-ps3remote.1 new file mode 100644 index 0000000..3b6e6fc --- /dev/null +++ b/docs/manpages/kodi-ps3remote.1 @@ -0,0 +1,16 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. +.TH KODI-PS3REMOTE "1" "October 2014" "kodi-ps3remote " "User Commands" +.SH NAME +kodi-ps3remote \- PS3 Blu\-Ray Remote Control Client for Kodi +.SH DESCRIPTION +This script is the Kodi remote control client that will allow Kodi to be +controlled by a PS3 Blu-Ray Remote. +.SH USAGE +Usage for kodi-ps3remote +.SS "Arguments:" +.TP +\fB\-\-address\fR ADDRESS +(default: localhost) +.TP +\fB\-\-port\fR PORT +(default: 9777) diff --git a/docs/manpages/kodi-send.1 b/docs/manpages/kodi-send.1 new file mode 100644 index 0000000..03ca685 --- /dev/null +++ b/docs/manpages/kodi-send.1 @@ -0,0 +1,26 @@ +.TH KODI-SEND "1" "October 2014" "kodi-send" +.SH NAME +xbmc\-send \- program to send some action to Kodi +.SH SYNOPSIS +xbmc\-send [OPTION] \fB\-\-action\fR=\fIACTION\fR +.SH DESCRIPTION +This program is used for sending actions for Kodi. +.PP +Example +.IP +kodi\-send \fB\-\-host\fR=\fI192\fR.168.0.1 \fB\-\-port\fR=\fI9777\fR \fB\-\-action=\fR"Quit" +.PP +Options +.TP +\-?, \fB\-\-help\fR +Display help message +.TP +\fB\-\-host\fR=\fIHOST\fR +Choose what HOST to connect to (default=localhost) +.TP +\fB\-\-port\fR=\fIPORT\fR +Choose what PORT to connect to (default=9777) +.TP +\fB\-\-action\fR=\fIACTION\fR +Sends an action to Kodi, this option can be added multiple times to create a macro. + diff --git a/docs/manpages/kodi-standalone.1 b/docs/manpages/kodi-standalone.1 new file mode 100644 index 0000000..54e2fc0 --- /dev/null +++ b/docs/manpages/kodi-standalone.1 @@ -0,0 +1,6 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. +.TH KODI-STANDALONE "1" "October 2014" "kodi-standalone " "User Commands" +.SH NAME +kodi-standalone \- Kodi standalone mode +.SH DESCRIPTION +This script runs Kodi in standalone mode. diff --git a/docs/manpages/kodi-wiiremote.1 b/docs/manpages/kodi-wiiremote.1 new file mode 100644 index 0000000..b947c93 --- /dev/null +++ b/docs/manpages/kodi-wiiremote.1 @@ -0,0 +1,35 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. +.TH KODI-WIIREMOTE "1" "October 2014" "kodi-wiiremote " "User Commands" +.SH NAME +kodi-wiiremote \- Wiimote Remote Control Client for Kodi +.SH DESCRIPTION +This script is the Kodi remote control client that will allow Kodi to be +controlled by a Wiimote. +.SS "Arguments:" +.HP +\fB\-\-disable\-mouseemulation\fR +.HP +\fB\-\-disable\-reconnect\fR +.HP +\fB\-\-disable\-nunchuck\fR +.HP +\fB\-\-address\fR ADDRESS +.HP +\fB\-\-port\fR PORT +.HP +\fB\-\-btaddr\fR MACADDRESS +.TP +\fB\-\-deadzone\-x\fR DEADX +| Number between 0 \- 100 (Default: 50) +.TP +\fB\-\-deadzone\-y\fR DEADY +| Number between 0 \- 100 (Default: 30) +.TP +\fB\-\-deadzone\fR DEAD +| Sets both X and Y too the number +.TP +\fB\-\-smoothing\-samples\fR SAMPLE +| Number 1 counts as Off (Default: 16) +.TP +\fB\-\-joystick\-map\fR JOYMAP +| The string ID for the joymap (Default: WiiRemote) diff --git a/docs/manpages/kodi.1 b/docs/manpages/kodi.1 new file mode 100644 index 0000000..5f55c7a --- /dev/null +++ b/docs/manpages/kodi.1 @@ -0,0 +1 @@ +.so man1/kodi.bin.1 diff --git a/docs/manpages/kodi.bin.1 b/docs/manpages/kodi.bin.1 new file mode 100644 index 0000000..35c8702 --- /dev/null +++ b/docs/manpages/kodi.bin.1 @@ -0,0 +1,33 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. +.TH KODI.BIN "1" "October 2014" "kodi.bin " "User Commands" +.SH NAME +kodi.bin \- Kodi main executable +.SH SYNOPSIS +.B kodi.bin +[\fIOPTION\fR]... [\fIFILE\fR]... +.SH DESCRIPTION +This is the main executable that will run Kodi. +.SS "Arguments:" +.TP +\fB\-fs\fR +Runs Kodi in full screen +.TP +\fB\-\-standalone\fR +Kodi runs in a stand alone environment without a window +manager and supporting applications. For example, that +enables network settings. +.TP +\fB\-p\fR or \fB\-\-portable\fR +Kodi will look for configurations in install folder instead of ~/.kodi +.TP +\fB\-\-version\fR +Print version information. +.TP +\fB\-\-test\fR [\fIFILE\fR] +Enable test mode. \fIFILE\fR must be readable. +.TP +\fB\-\-settings=\fR<\fIfilename\fR> +Loads specified file after advancedsettings.xml replacing any settings specified. The \fIfilename\fR must exist in special://xbmc/system/. +.TP +\fB\-\-windowing=\fR<\fIsystem\fR> +Select which windowing method to use. Available window systems are: x11 wayland gbm diff --git a/docs/resources/android.svg b/docs/resources/android.svg new file mode 100644 index 0000000..22c6b8c --- /dev/null +++ b/docs/resources/android.svg @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg width="100" height="100" version="1.1" viewBox="0 0 26.458333 26.458334" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+ <metadata>
+ <rdf:RDF>
+ <cc:Work rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
+ <dc:title/>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g transform="translate(0 -270.54)">
+ <rect x="-1.4211e-14" y="270.54" width="26.458" height="26.458" fill="#a4c639" stroke-width=".27763"/>
+ <path d="m21.059 281.63c0-0.62897-0.50779-1.1406-1.1391-1.1406-0.63126 0-1.1421 0.50935-1.1421 1.1422v4.7769c0 0.62508 0.51165 1.1421 1.1445 1.1421 0.62818 0 1.1391-0.51705 1.1391-1.1421v-4.7846h-0.0079zm-12.929-0.92221 0.0032 7.4085c0 0.68298 0.54328 1.227 1.2139 1.227h0.82033v2.5312c0 0.63281 0.50933 1.1437 1.1344 1.1437 0.62509 0 1.1321-0.50932 1.1421-1.1328v-2.5312h1.538v2.5312c0 0.63511 0.50933 1.1444 1.1344 1.1444 0.63512 0 1.1437-0.50932 1.1437-1.1499v-2.5312h0.83191c0.67139 0 1.2139-0.54791 1.2139-1.2178v-7.4316l-10.209 6e-3 0.03086 2e-3zm7.4455-2.2611c-0.23923 0-0.43216-0.1928-0.43216-0.43214 0-0.23538 0.19294-0.43063 0.43216-0.43217 0.23923 0 0.43216 0.19688 0.43216 0.43217 0 0.23917-0.19294 0.43214-0.43216 0.43214m-4.6766 0c-0.23923 0-0.43216-0.1928-0.43216-0.43214 0-0.23684 0.19294-0.43063 0.43216-0.43063 0.23923 0 0.43216 0.19688 0.43216 0.43987 0 0.24297-0.19449 0.43757-0.43988 0.43757m4.8541-2.238 0.7941-1.4593c0.04629-0.0811 0.01079-0.17442-0.05866-0.21992-0.08027-0.0347-0.17287-0.0117-0.21916 0.0694l-0.8103 1.4662c-0.66985-0.31253-1.4323-0.48616-2.2303-0.48616-0.79795 0-1.5573 0.16596-2.2318 0.46534l-0.79795-1.4686c-0.04089-0.0755-0.13892-0.10413-0.21452-0.0618-0.07718 0.0347-0.10494 0.13884-0.06175 0.20826l0.79487 1.447c-1.5666 0.80799-2.6238 2.346-2.6238 4.1132h10.285c0-1.7672-1.0557-3.3053-2.6207-4.1132m-9.2127 4.3002c-0.63049 0-1.1421 0.51319-1.1421 1.1445v4.7785c0 0.63281 0.51242 1.1421 1.1452 1.1421 0.62817 0 1.1398-0.50932 1.1398-1.1421v-4.7769c0-0.62897-0.50933-1.1406-1.1344-1.1406" fill="#ffffff" stroke-width=".77172"/>
+ </g>
+</svg>
diff --git a/docs/resources/banner.png b/docs/resources/banner.png Binary files differnew file mode 100644 index 0000000..bd5e66a --- /dev/null +++ b/docs/resources/banner.png diff --git a/docs/resources/banner_slim.png b/docs/resources/banner_slim.png Binary files differnew file mode 100644 index 0000000..ea575b3 --- /dev/null +++ b/docs/resources/banner_slim.png diff --git a/docs/resources/fedora.svg b/docs/resources/fedora.svg new file mode 100644 index 0000000..5bbcdae --- /dev/null +++ b/docs/resources/fedora.svg @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg width="100" height="100" version="1.1" viewBox="0 0 26.458333 26.458334" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <metadata>
+ <rdf:RDF>
+ <cc:Work rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
+ <dc:title/>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <rect x="-1.4211e-14" y="8.5449e-6" width="26.458" height="26.458" fill="#294172" stroke-width=".27763"/>
+ <path id="voice" d="m22.489 13.23c0-5.1145-4.1461-9.2611-9.2602-9.2611-5.1122 0-9.2567 4.1428-9.2602 9.2541v7.1663c0.00273 1.1606 0.94405 2.1001 2.1054 2.1001h7.1587c5.1128-0.0018 9.2567-4.1468 9.2567-9.2602" fill="#ffffff" stroke-width=".069562"/>
+ <path id="in" d="m9.3076 13.825h3.3282v3.3282c0 1.8372-1.491 3.3282-3.3282 3.3282s-3.3282-1.491-3.3282-3.3282 1.491-3.3282 3.3282-3.3282z" fill="none" stroke="#3c6eb4" stroke-width="2.0319"/>
+ <use id="finity" transform="rotate(180 12.628 13.834)" width="100%" height="100%" xlink:href="#in"/>
+ <path id="free" d="m13.654 12.819v4.3369c0 2.4002-1.946 4.3463-4.3463 4.3463-0.36415 0-0.62303-0.04112-0.96015-0.12923-0.49152-0.12863-0.89321-0.53163-0.89339-1.0004 0-0.5666 0.41128-0.9787 1.026-0.9787 0.2926 0 0.39878 0.05618 0.82744 0.05618 1.2654 0 2.2919-1.025 2.2941-2.2904v-1.9934c0-0.17862-0.14515-0.32334-0.32407-0.32334l-1.5071-2.72e-4c-0.56151 0-1.0152-0.44787-1.0152-1.0109-2.996e-4 -0.56656 0.45833-1.0126 1.0259-1.0126" fill="#294172" stroke-width=".069562"/>
+ <use id="dom" transform="rotate(180 12.628 13.834)" width="100%" height="100%" xlink:href="#free"/>
+</svg>
diff --git a/docs/resources/freebsd.svg b/docs/resources/freebsd.svg new file mode 100644 index 0000000..f547bfd --- /dev/null +++ b/docs/resources/freebsd.svg @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg width="100" height="100" version="1.1" viewBox="0 0 26.458333 26.458334" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+ <metadata>
+ <rdf:RDF>
+ <cc:Work rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
+ <dc:title/>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g transform="translate(0 -270.54)">
+ <rect x="-1.4211e-14" y="270.54" width="26.458" height="26.458" fill="#990000" stroke-width=".27763"/>
+ <path d="m22.42 274.83c0.99718 0.99658-1.7672 5.3777-2.2346 5.8453-0.46729 0.46662-1.6543 0.0373-2.6509-0.95968-0.99718-0.99659-1.4267-2.1838-0.95938-2.6512 0.46707-0.46751 4.8479-3.2317 5.8449-2.2345m-13.983 1.0545c-1.5223-0.86371-3.6886-1.8246-4.3776-1.1354-0.6982 0.6979 0.29779 2.9128 1.1707 4.4379a9.3614 9.3614 0 0 1 3.2069 -3.3025" fill="#ffffff" stroke-width=".073821"/>
+ <path d="m20.831 280.03c0.14342 0.48638 0.11767 0.88818-0.11495 1.1204-0.54326 0.54348-2.0108-0.0351-3.3337-1.2941a6.7507 6.7507 0 0 1 -0.27393 -0.25891c-0.47838-0.47853-0.85057-0.98787-1.0886-1.457-0.46335-0.83123-0.57928-1.5654-0.22907-1.9156 0.19085-0.19062 0.4962-0.24258 0.8687-0.17559 0.24289-0.15363 0.52966-0.32476 0.84408-0.50006-1.2786-0.66689-2.7322-1.0435-4.2742-1.0435-5.1145 0-9.2608 4.1456-9.2608 9.2606 0 5.1141 4.1464 9.2602 9.2608 9.2602 5.1146 0 9.2607-4.1461 9.2607-9.2602 0-1.6518-0.43352-3.2006-1.1908-4.5433-0.16366 0.2987-0.3228 0.57233-0.46811 0.80715" fill="#ffffff" stroke-width=".075526"/>
+ </g>
+</svg>
diff --git a/docs/resources/gitfu/fix_commits_01.png b/docs/resources/gitfu/fix_commits_01.png Binary files differnew file mode 100644 index 0000000..cb8a374 --- /dev/null +++ b/docs/resources/gitfu/fix_commits_01.png diff --git a/docs/resources/gitfu/fix_commits_02.png b/docs/resources/gitfu/fix_commits_02.png Binary files differnew file mode 100644 index 0000000..eebffc6 --- /dev/null +++ b/docs/resources/gitfu/fix_commits_02.png diff --git a/docs/resources/gitfu/fix_commits_03.png b/docs/resources/gitfu/fix_commits_03.png Binary files differnew file mode 100644 index 0000000..04b043b --- /dev/null +++ b/docs/resources/gitfu/fix_commits_03.png diff --git a/docs/resources/gitfu/fix_commits_04.png b/docs/resources/gitfu/fix_commits_04.png Binary files differnew file mode 100644 index 0000000..2e1c6ee --- /dev/null +++ b/docs/resources/gitfu/fix_commits_04.png diff --git a/docs/resources/gitfu/fix_commits_05.png b/docs/resources/gitfu/fix_commits_05.png Binary files differnew file mode 100644 index 0000000..01e1c7c --- /dev/null +++ b/docs/resources/gitfu/fix_commits_05.png diff --git a/docs/resources/gitfu/fix_commits_06.png b/docs/resources/gitfu/fix_commits_06.png Binary files differnew file mode 100644 index 0000000..2ae112a --- /dev/null +++ b/docs/resources/gitfu/fix_commits_06.png diff --git a/docs/resources/gitfu/fix_commits_07.png b/docs/resources/gitfu/fix_commits_07.png Binary files differnew file mode 100644 index 0000000..d3b1e7a --- /dev/null +++ b/docs/resources/gitfu/fix_commits_07.png diff --git a/docs/resources/gitfu/fix_commits_08.png b/docs/resources/gitfu/fix_commits_08.png Binary files differnew file mode 100644 index 0000000..11bf744 --- /dev/null +++ b/docs/resources/gitfu/fix_commits_08.png diff --git a/docs/resources/gitfu/rebase_branch_01.png b/docs/resources/gitfu/rebase_branch_01.png Binary files differnew file mode 100644 index 0000000..5e77edf --- /dev/null +++ b/docs/resources/gitfu/rebase_branch_01.png diff --git a/docs/resources/gitfu/rebase_branch_02.png b/docs/resources/gitfu/rebase_branch_02.png Binary files differnew file mode 100644 index 0000000..b26decb --- /dev/null +++ b/docs/resources/gitfu/rebase_branch_02.png diff --git a/docs/resources/gitfu/rebase_branch_03.png b/docs/resources/gitfu/rebase_branch_03.png Binary files differnew file mode 100644 index 0000000..2dcd565 --- /dev/null +++ b/docs/resources/gitfu/rebase_branch_03.png diff --git a/docs/resources/ios.svg b/docs/resources/ios.svg new file mode 100644 index 0000000..fa5dc95 --- /dev/null +++ b/docs/resources/ios.svg @@ -0,0 +1,26 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg width="100" height="100" version="1.1" viewBox="0 0 26.458333 26.458334" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+ <defs>
+ <clipPath id="clipPath91">
+ <path d="m137.5 6.34h-0.16l-9.44 5.2-0.56-2.16 10.4-5.76h2.48v52h-2.72zm21.52 47.08c-2.29-2.053-4.09-5.08-5.4-9.08s-1.96-8.853-1.96-14.56c0-5.76 0.69-10.68 2.08-14.76s3.29-7.1467 5.72-9.2 5.16-3.08 8.2-3.08c4.64 0 8.29 2.2933 10.96 6.88 2.67 4.587 4 11.067 4 19.44 0 8.907-1.39 15.707-4.16 20.4s-6.67 7.04-11.68 7.04c-2.88 0-5.47-1.027-7.76-3.08zm17.44-5.68c2.24-4.347 3.36-10.52 3.36-18.52 0-7.68-1.08-13.64-3.24-17.88-2.16-4.24-5.21-6.36-9.16-6.36-2.51 0-4.73 0.9467-6.68 2.84-1.95 1.893-3.48 4.707-4.6 8.44s-1.68 8.267-1.68 13.6c0 5.173 0.53 9.6 1.6 13.28s2.53 6.453 4.4 8.32 4.03 2.8 6.48 2.8c4.11 0 7.28-2.173 9.52-6.52zm-174.52-38.44c-0.96-0.96-1.44-2.1867-1.44-3.68s0.48-2.72 1.44-3.68c0.96-0.96 2.1867-1.44 3.68-1.44 1.5467 0 2.8 0.48 3.76 1.44 0.96 0.96 1.44 2.1867 1.44 3.68s-0.48 2.72-1.44 3.68c-0.96 0.96-2.2133 1.44-3.76 1.44-1.4933 0-2.72-0.48-3.68-1.44zm-0.56 7.44h8.56v38.88h-8.56zm28.28 36.28c-3.653-2.32-6.48-5.547-8.48-9.68s-3-8.867-3-14.2c0-5.493 1.04-10.387 3.12-14.68s4.987-7.64 8.72-10.04 8.053-3.6 12.96-3.6c4.8 0 9.027 1.1467 12.68 3.44s6.48 5.52 8.48 9.68c2 4.16 3 8.907 3 14.24 0 5.6-1.013 10.533-3.04 14.8s-4.907 7.587-8.64 9.96-8.107 3.56-13.12 3.56c-4.8 0-9.027-1.16-12.68-3.48zm21.08-6.2c2.347-1.813 4.147-4.307 5.4-7.48s1.88-6.787 1.88-10.84c0-3.947-0.64-7.493-1.92-10.64s-3.08-5.613-5.4-7.4c-2.32-1.7867-5-2.68-8.04-2.68-3.093 0-5.8 0.9067-8.12 2.72-2.32 1.813-4.107 4.32-5.36 7.52s-1.88 6.827-1.88 10.88c0 3.893 0.627 7.413 1.88 10.56s3.053 5.613 5.4 7.4 5.04 2.68 8.08 2.68 5.733-0.907 8.08-2.72zm22.48 6.32 2-7.2c3.733 2.293 7.867 3.44 12.4 3.44 3.2 0 5.733-0.747 7.6-2.24s2.8-3.467 2.8-5.92c0-2.187-0.76-4.027-2.28-5.52s-4.013-2.907-7.48-4.24c-4.747-1.813-8.293-4-10.64-6.56s-3.52-5.547-3.52-8.96c0-2.933 0.76-5.533 2.28-7.8 1.52-2.2667 3.667-4.04 6.44-5.32s5.947-1.92 9.52-1.92c5.013 0 9.07 0.8533 12.16 2.56l-2.16 6.96c-2.987-1.6533-6.4-2.48-10.24-2.48-2.773 0-5.027 0.6533-6.76 1.96-1.733 1.307-2.6 3.027-2.6 5.16 0 1.387 0.307 2.587 0.92 3.6s1.653 1.973 3.12 2.88 3.56 1.92 6.28 3.04c4.64 1.867 8.07 4.093 10.28 6.68s3.32 5.693 3.32 9.32c0 3.147-0.8 5.92-2.4 8.32s-3.87 4.253-6.8 5.56c-2.933 1.307-6.4 1.96-10.4 1.96-5.653 0-10.267-1.093-13.84-3.28z" fill="#000000"/>
+ </clipPath>
+ <clipPath id="clipPath85">
+ <path class="st0" d="m54.357 55.615h-6.0355v-22.289c0-8.2067-2.8962-12.31-8.6898-12.31-1.3423 0-2.5749 0.28164-3.7012 0.84723-1.1215 0.56443-2.1052 1.3272-2.9371 2.2932-0.82947 0.96642-1.4744 2.0643-1.9323 3.2974-0.45563 1.233-0.68935 2.5219-0.68935 3.8617v24.3h-6.033v-23.735c0-3.2186-0.70104-5.8347-2.0924-7.8457-1.3949-2.011-3.4593-3.0177-6.1955-3.0177-1.3926 0-2.6824 0.30734-3.8613 0.92552-1.1799 0.61818-2.1998 1.4492-3.0586 2.494-0.86453 1.0447-1.5281 2.2271-2.0118 3.5415-0.479 1.3143-0.72429 2.6414-0.72429 3.9837v23.654h-6.0332v-28.723c0-1.556 0-3.178-0.11687-4.8687 0-1.6906-0.14022-3.4473-0.24541-5.2701h5.3929v6.3557h0.56068c2.7362-4.7745 6.7586-7.1617 12.069-7.1617 2.5761 0 4.8158 0.69882 6.72 2.0924 1.9043 1.3958 3.2561 3.3 4.0622 5.7127h0.16359c1.3937-2.5755 3.1778-4.5179 5.3497-5.8322 2.1729-1.3143 4.6521-1.9728 7.4443-1.9728 3.8075 0 6.8509 1.4618 9.1314 4.3855 2.2806 2.9237 3.4197 6.9889 3.4197 12.191v23.092zm31.385 0-0.56081-4.988h-0.24528c-2.6298 3.9151-6.5449 5.8728-11.748 5.8728-1.6624 0-3.193-0.26995-4.5867-0.80399-1.3961-0.53638-2.603-1.2991-3.6206-2.2932-1.0164-0.99447-1.8225-2.1585-2.4125-3.5009-0.59586-1.3398-0.88789-2.8169-0.88789-4.4262 0-4.7211 1.9569-8.3007 5.873-10.741 3.915-2.4407 9.6023-3.661 17.056-3.661v-0.88462c0-6.3812-2.9768-9.5744-8.9316-9.5744-3.7011 0-6.9735 0.93838-9.8148 2.8168l-1.4498-4.1847c3.4325-2.1991 7.4818-3.2999 12.15-3.2999 9.4398 0 14.161 5.1762 14.161 15.529v14.888c0 1.8762 0 3.5821 0.11687 5.11 0.11687 1.5306 0.23372 2.9111 0.44395 4.1441h-5.5529zm-1.0398-20.115h-1.2081c-10.406 0-15.61 3.0584-15.61 9.1728 0 2.4151 0.64249 4.21 1.9323 5.3922 1.2862 1.1796 2.895 1.7694 4.8273 1.7694 1.2338 0 2.4535-0.21387 3.6614-0.64389 1.2069-0.43004 2.2806-1.0319 3.2187-1.8101 0.93464-0.77828 1.7034-1.7287 2.2922-2.855 0.59586-1.1265 0.88789-2.3872 0.88789-3.7804zm41.923-12.633c-2.3624-1.2891-5.0972-1.9321-8.2072-1.9321-2.1988 0-4.1591 0.38914-5.8754 1.1674-1.7163 0.77828-3.1649 1.8508-4.3448 3.2185-1.1788 1.3678-2.0924 2.9898-2.735 4.8687-0.6426 1.8763-0.96969 3.9151-0.96969 6.1143 0 2.2525 0.33877 4.3193 1.0048 6.1956 0.66586 1.8763 1.6088 3.4728 2.8167 4.7872 1.2046 1.3143 2.6415 2.3339 4.304 3.0583 1.6625 0.72452 3.513 1.0856 5.5529 1.0856 2.8951 0 5.7656-0.64272 8.6104-1.9321l1.2044 4.6652c-3.0048 1.5025-6.6499 2.2525-10.941 2.2525-2.8459 0-5.4185-0.47094-7.7271-1.4085-2.305-0.93838-4.2911-2.2804-5.9536-4.0219-1.6625-1.744-2.9359-3.8212-3.8216-6.2364-0.88789-2.4151-1.3271-5.1228-1.3271-8.1278 0-3.0583 0.50238-5.8473 1.4872-8.3693 0.99307-2.5194 2.3751-4.6932 4.144-6.5161 1.77-1.8228 3.9032-3.2466 6.3964-4.2635 2.4943-1.0202 5.2432-1.5304 8.2482-1.5304 3.9149 0 7.1336 0.69882 9.6559 2.0922zm53.27 5.0695c0 4.238-0.5725 8.0997-1.7314 11.585-1.1567 3.488-2.7887 6.4906-4.9092 9.0125-2.1181 2.522-4.6685 4.4796-7.6453 5.8729-2.9768 1.3932-6.29 2.0922-9.9351 2.0922-3.4886 0-6.6791-0.68363-9.5742-2.0517-2.8985-1.3678-5.3928-3.2721-7.4852-5.7125-2.0924-2.4407-3.714-5.3389-4.8683-8.6898-1.1567-3.3508-1.7291-7.0397-1.7291-11.064 0-4.182 0.60755-8.0311 1.8109-11.545 1.2069-3.5134 2.8821-6.5159 5.0283-9.0125 2.1462-2.494 4.7059-4.4388 7.6827-5.832 2.9804-1.3932 6.2387-2.0925 9.781-2.0925 3.5389 0 6.7703 0.67194 9.6934 2.011 2.9242 1.3424 5.4057 3.2186 7.4444 5.6338 2.0387 2.4152 3.6206 5.311 4.7468 8.6898 1.1216 3.3786 1.6905 7.0804 1.6905 11.102zm-6.5191 0.32253c0-3.2185-0.43226-6.2084-1.2886-8.972-0.86452-2.7609-2.0515-5.176-3.5796-7.2405-1.5305-2.0643-3.353-3.6737-5.4712-4.8279-2.1181-1.1522-4.4663-1.7288-7.0401-1.7288-2.6287 0-5.0283 0.57728-7.2025 1.7288-2.1731 1.1546-4.0212 2.761-5.5517 4.8279-1.5305 2.0644-2.7233 4.533-3.582 7.4033-0.86464 2.8703-1.2864 5.9949-1.2864 9.3736 0 3.1652 0.43226 6.1296 1.2864 8.8906 0.85283 2.7635 2.0515 5.1633 3.582 7.2024 1.5281 2.039 3.3658 3.6482 5.512 4.8279 2.145 1.1796 4.5049 1.7695 7.0798 1.7695 2.6287 0 5.0284-0.59014 7.2025-1.7695 2.1742-1.1797 4.0225-2.8169 5.553-4.9094 1.5305-2.0922 2.7069-4.5456 3.5411-7.3626 0.82946-2.8169 1.2454-5.8879 1.2454-9.2134zm43.052 12.793c0 2.3059-0.43224 4.4135-1.2886 6.3177-0.85283 1.9042-2.0796 3.5287-3.6614 4.8685-1.5807 1.3424-3.4979 2.3746-5.7527 3.0992-2.2524 0.72452-4.7748 1.0856-7.5636 1.0856-5.5809 0-10.004-1.1522-13.276-3.4601l1.6882-5.0693c3.5925 2.2525 7.5892 3.3786 11.99 3.3786 3.7012 0 6.5716-0.88462 8.6103-2.6541 2.0398-1.7695 3.0586-4.1287 3.0586-7.0805 0-2.7356-0.79443-4.9473-2.374-6.6379-1.5842-1.6881-4.1977-3.2313-7.8463-4.627-9.2798-3.4856-13.919-8.5829-13.919-15.287 0-2.0899 0.40887-4.0221 1.2454-5.7915 0.82949-1.7695 1.999-3.3 3.5014-4.5864 1.5024-1.2864 3.2841-2.2779 5.3484-2.977 2.0644-0.69648 4.304-1.0447 6.72-1.0447 4.665 0 8.4736 0.86008 11.425 2.5753l-1.8506 4.988c-2.6287-1.6626-5.9011-2.4939-9.816-2.4939-3.1112 0-5.6335 0.77828-7.5635 2.3338-1.9324 1.5559-2.895 3.6203-2.895 6.1956 0 1.2331 0.17531 2.3339 0.52578 3.3 0.35043 0.96642 0.92293 1.8763 1.7314 2.7356 0.80608 0.86008 1.8915 1.678 3.2584 2.4533 1.3681 0.77828 3.0995 1.5966 5.1896 2.4535 2.4125 0.96642 4.4793 1.9983 6.1955 3.099 1.7162 1.1008 3.124 2.2932 4.2257 3.5796 1.0982 1.2891 1.8915 2.6975 2.374 4.2254 0.479 1.5203 0.72428 3.1956 0.72428 5.0211z" fill="#000000" stroke-width=".025423"/>
+ </clipPath>
+ </defs>
+ <metadata>
+ <rdf:RDF>
+ <cc:Work rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
+ <dc:title/>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g transform="translate(0 -270.54)">
+ <rect x="-1.4211e-14" y="270.54" width="26.458" height="26.458" fill="#2b2e34" stroke-width=".27763"/>
+ <path transform="matrix(.073349 0 0 .073349 9.0388 282.02)" d="m0 0h11.3v57h-11.3z" clip-path="url(#clipPath91)" fill="#ffffff"/>
+ <rect transform="matrix(.085574 0 0 .085574 -.97945 281.33)" x="131" width="86.5" height="57" clip-path="url(#clipPath85)" fill="#ffffff"/>
+ </g>
+</svg>
diff --git a/docs/resources/kodi.gif b/docs/resources/kodi.gif Binary files differnew file mode 100644 index 0000000..038b956 --- /dev/null +++ b/docs/resources/kodi.gif diff --git a/docs/resources/linux.svg b/docs/resources/linux.svg new file mode 100644 index 0000000..90f70b7 --- /dev/null +++ b/docs/resources/linux.svg @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg width="100" height="100" version="1.1" viewBox="0 0 26.458333 26.458334" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+ <defs>
+ <clipPath id="clipPath1114">
+ <path d="m11.986 274.51c-0.1196 0-0.24304 6e-3 -0.3696 0.0175-3.2616 0.25693-2.3966 3.7091-2.446 4.8595-0.0594 0.84336-0.23147 1.5077-0.81095 2.331-0.68287 0.81096-1.6412 2.1219-2.0957 3.4884-0.21449 0.64196-0.31636 1.2994-0.22146 1.9205-0.0301 0.0262-0.05865 0.0525-0.08565 0.10411-0.20061 0.20676-0.34645 0.46372-0.5108 0.64736-0.15354 0.15339-0.37422 0.20618-0.61496 0.30866-0.24153 0.10498-0.50771 0.20764-0.66666 0.52545-0.06944 0.14494-0.10493 0.30324-0.10187 0.46372 0 0.15369 0.020709 0.30942 0.04243 0.41359 0.04474 0.30787 0.0895 0.56249 0.0301 0.74843-0.19137 0.5247-0.21528 0.88428-0.08101 1.1458 0.13427 0.2578 0.41281 0.36188 0.72453 0.46372 0.62577 0.15427 1.4738 0.10411 2.1412 0.4622 0.7145 0.36034 1.4398 0.51776 2.0185 0.36264 0.40586-0.0886 0.74845-0.35724 0.93209-0.72916 0.45293-2e-3 0.94907-0.20763 1.7438-0.2578 0.53935-0.0446 1.2145 0.20619 1.9892 0.1534 0.01925 0.10411 0.04861 0.15369 0.08796 0.2578l0.0023 2e-3c0.3017 0.60029 0.85879 0.87346 1.4537 0.82639 0.5949-0.0464 1.2284-0.41359 1.7415-1.0077 0.48688-0.59026 1.2986-0.83642 1.8349-1.1597 0.26853-0.1534 0.48534-0.36188 0.50077-0.65818 0.01779-0.30863-0.15354-0.62653-0.55092-1.0625v-0.075l-0.0023-2e-3c-0.13117-0.15427-0.19291-0.4128-0.2608-0.71449-0.06559-0.30942-0.14042-0.60647-0.37963-0.80708h-0.0023c-0.04552-0.0417-0.0949-0.0516-0.14506-0.10411-0.04322-0.0295-0.09335-0.0478-0.1466-0.0493 0.33256-0.98608 0.2037-1.9676-0.13348-2.8503-0.41126-1.088-1.1304-2.0355-1.6782-2.6875-0.6142-0.77547-1.216-1.51-1.2045-2.5995 0.02071-1.6605 0.18288-4.7322-2.7346-4.7369zm0.40818 2.6273h0.0099c0.16436 0 0.30555 0.0478 0.45062 0.15281 0.14736 0.10411 0.25462 0.25634 0.33873 0.41128 0.08101 0.19977 0.1219 0.35416 0.12808 0.55865 0-0.0146 0.0047-0.0309 0.0047-0.0455v0.0802c-0.0015-6e-3 -0.0032-0.0117-0.0032-0.0175l-0.0032-0.0175c-0.0015 0.18751-0.04089 0.37267-0.11575 0.54473-0.03628 0.0965-0.09183 0.18518-0.16436 0.25838-0.02246-0.0117-0.04398-0.0233-0.06789-0.0324-0.08101-0.0347-0.15354-0.0493-0.21992-0.10265-0.0548-0.0204-0.11187-0.0394-0.16897-0.051 0.03782-0.0455 0.11187-0.10265 0.14042-0.15281 0.04089-0.0989 0.06328-0.20385 0.06789-0.31018v-0.0146c0.0015-0.10411-0.014-0.2091-0.04707-0.30863-0.03473-0.10411-0.07792-0.15515-0.14121-0.2578-0.0648-0.051-0.12884-0.10178-0.20601-0.10178h-0.01225c-0.07177 0-0.13581 0.0233-0.20216 0.10178-0.07329 0.0726-0.12808 0.15981-0.15818 0.2578-0.04089 0.098-0.0648 0.20356-0.06944 0.30863v0.0146c0.0015 0.0688 0.0061 0.13824 0.01546 0.20618-0.14894-0.0516-0.33796-0.10411-0.46836-0.15573-0.0079-0.0502-0.01225-0.10177-0.014-0.15368v-0.0146c-0.0061-0.20356 0.03319-0.40586 0.11575-0.59338 0.06328-0.16885 0.179-0.31327 0.33179-0.41126 0.13193-0.0994 0.29244-0.15339 0.45833-0.15339zm-2.2855 0.0455h0.0277c0.10956 0 0.20834 0.037 0.30787 0.10411 0.11266 0.0994 0.2037 0.22222 0.26544 0.35879 0.06944 0.15369 0.10881 0.30939 0.11805 0.51464v3e-3c0.0053 0.10352 0.0047 0.15514-0.0015 0.2053v0.0618c-0.02304 6e-3 -0.04322 0.0146-0.06404 0.0175-0.11729 0.0423-0.21143 0.10411-0.30324 0.15427 0.0093-0.0685 0.0099-0.13824 0.0023-0.20589v-0.0117c-0.0093-0.10265-0.03009-0.15369-0.06327-0.25692-0.02391-0.0787-0.06789-0.14903-0.12808-0.20618-0.03782-0.0347-0.08874-0.0525-0.14121-0.0493h-0.01633c-0.0548 6e-3 -0.10032 0.0318-0.14351 0.10178-0.04937 0.0595-0.08101 0.13211-0.09259 0.20822-0.020709 0.0834-0.02712 0.16915-0.017791 0.25547v0.0117c0.0093 0.10411 0.02858 0.15515 0.0625 0.2578 0.03473 0.10353 0.07483 0.15427 0.12732 0.20677 0.0085 6e-3 0.01633 0.0146 0.02625 0.0175-0.05401 0.044-0.09029 0.054-0.13581 0.10498-0.02858 0.0204-0.06174 0.0464-0.10108 0.0525-0.08026-0.0965-0.15124-0.20065-0.21219-0.31021-0.07407-0.16215-0.11266-0.33794-0.1196-0.51464-0.013121-0.17439 0.0085-0.34876 0.06174-0.51542 0.04243-0.15194 0.11729-0.29245 0.21837-0.41283 0.09877-0.10265 0.20061-0.15427 0.32253-0.15427zm1.0579 1.3164c0.25541 0 0.56481 0.0502 0.9375 0.30785 0.22607 0.15427 0.40355 0.20764 0.81249 0.36112h0.0023c0.19676 0.10499 0.3125 0.20531 0.36883 0.30787v-0.10119c0.05634 0.11344 0.06019 0.24526 0.01225 0.36264-0.0949 0.24001-0.39815 0.4969-0.82098 0.65048v2e-3c-0.20679 0.10411-0.38657 0.25693-0.59799 0.35879-0.21298 0.10411-0.4537 0.22514-0.78086 0.20589-0.11729 6e-3 -0.23534-0.0117-0.34568-0.0516-0.08486-0.0464-0.16821-0.0971-0.24847-0.15281-0.15045-0.10411-0.28008-0.25634-0.47222-0.35882v-3e-3h-0.0038c-0.30864-0.18985-0.47531-0.39507-0.52932-0.54861-0.05325-0.20676-0.0038-0.36188 0.14894-0.46296 0.17285-0.10411 0.29321-0.2091 0.37268-0.25926 0.08026-0.0572 0.11032-0.0787 0.13581-0.10119h0.0015v-2e-3c0.13039-0.15572 0.33642-0.36188 0.64737-0.46374 0.10726-0.0292 0.22686-0.0502 0.35956-0.0502zm2.1597 1.6535c0.27702 1.0933 0.9236 2.6813 1.3395 3.4514 0.22068 0.41205 0.65972 1.2801 0.8503 2.3333 0.12036-3e-3 0.25386 0.0146 0.39583 0.0493 0.49846-1.2894-0.4213-2.6751-0.84028-3.0602-0.17052-0.15514-0.179-0.25838-0.0949-0.25838 0.45447 0.41204 1.0532 1.2129 1.2701 2.1273 0.09953 0.41281 0.12269 0.85185 0.01633 1.2886 0.05171 0.0204 0.10417 0.047 0.15818 0.0516 0.79629 0.41202 1.0903 0.72377 0.94907 1.1859v-0.0332c-0.04707-2e-3 -0.09259 0-0.13966 0h-0.01167c0.1165-0.36034-0.14042-0.63657-0.82175-0.94444-0.70602-0.30863-1.2701-0.25926-1.3665 0.35882-0.0052 0.0332-0.0093 0.051-0.01312 0.10411-0.05246 0.0175-0.10726 0.0408-0.16127 0.0493-0.33179 0.20677-0.5108 0.51619-0.61188 0.91589-0.10032 0.41126-0.13118 0.89198-0.15818 1.4421v2e-3c-0.01633 0.2578-0.13193 0.6466-0.24613 1.0424-1.1574 0.82715-2.7623 1.1867-4.1273 0.2578-0.08565-0.14902-0.18982-0.28871-0.31018-0.41125-0.0571-0.0965-0.12963-0.18285-0.21219-0.2578 0.14042 0 0.2608-0.0233 0.35879-0.0516 0.11187-0.0516 0.19831-0.14494 0.24228-0.2578 0.08335-0.20589 0-0.53779-0.2662-0.89737-0.2662-0.36033-0.71836-0.76774-1.3796-1.1736-0.48611-0.30787-0.7608-0.6713-0.88734-1.0772-0.12732-0.41204-0.11032-0.83718-0.011671-1.2693 0.18903-0.8256 0.67361-1.6281 0.98302-2.1319 0.08256-0.0502 0.02858 0.10412-0.31481 0.75153-0.30555 0.57947-0.88039 1.9267-0.09414 2.9737 0.02931-0.76311 0.19907-1.5162 0.49923-2.2191 0.43518-0.98608 1.3449-2.7037 1.4167-4.0648 0.03704 0.0292 0.16742 0.10411 0.22298 0.15573 0.16821 0.10265 0.29321 0.25693 0.45525 0.35882 0.16282 0.15515 0.36805 0.25838 0.67592 0.25838 0.0301 2e-3 0.05786 6e-3 0.08565 6e-3 0.31712 0 0.5625-0.10353 0.76851-0.20677 0.22377-0.10323 0.402-0.2578 0.57098-0.30863h0.0038c0.36034-0.10411 0.64506-0.3102 0.80632-0.54012zm1.6867 6.912c0.02858 0.46372 0.26465 0.96063 0.68055 1.0625 0.4537 0.10323 1.1065-0.25693 1.3819-0.59029l0.16282-6e-3c0.24304-6e-3 0.44522 9e-3 0.65355 0.20589l0.0023 2e-3c0.16048 0.1534 0.23534 0.40971 0.3017 0.67591 0.06559 0.30942 0.11884 0.60186 0.31559 0.82254 0.375 0.40661 0.49768 0.69906 0.49074 0.87961l0.0023-6e-3v0.0146l-0.0023-9e-3c-0.01167 0.2021-0.14275 0.30557-0.38426 0.45911-0.48611 0.30942-1.3472 0.54937-1.8958 1.2114-0.47685 0.56865-1.0579 0.87885-1.571 0.91895-0.51234 0.0408-0.95447-0.15427-1.2145-0.69288l-0.0038-2e-3c-0.16203-0.30939-0.09259-0.79087 0.04322-1.304 0.13581-0.51542 0.33025-1.0378 0.35725-1.4645 0.02858-0.55091 0.05865-1.0301 0.15045-1.3997 0.09259-0.35882 0.23765-0.61499 0.4946-0.75926l0.03473-0.0175zm-8.3449 0.0379h0.0076c0.04089 0 0.08102 3e-3 0.12114 0.0117 0.29011 0.0426 0.54475 0.25693 0.78935 0.58026l0.70216 1.284 0.0023 2e-3c0.18749 0.41126 0.58179 0.821 0.91744 1.2639 0.33487 0.46142 0.59413 0.87267 0.5625 1.2114v6e-3c-0.04398 0.57407-0.3696 0.88579-0.86805 0.99845-0.49768 0.10411-1.1728 2e-3 -1.848-0.358-0.74691-0.41359-1.6343-0.36189-2.2045-0.46451-0.28472-0.051-0.47145-0.15515-0.55787-0.30942-0.08565-0.15339-0.0872-0.46375 0.0949-0.94907v-2e-3l0.00151-2e-3c0.09029-0.2578 0.02304-0.58101-0.020709-0.8634-0.04243-0.30941-0.06404-0.54706 0.03319-0.72531 0.12345-0.2578 0.30555-0.30787 0.53163-0.41128 0.22762-0.10411 0.49459-0.15573 0.70678-0.36188h0.00151v-2e-3c0.19752-0.20676 0.34336-0.46371 0.51543-0.6466 0.1466-0.15514 0.29321-0.25925 0.51157-0.25925zm5.5239-7.0015c-0.33564 0.15515-0.72916 0.4128-1.1481 0.4128-0.41821 0-0.74845-0.20589-0.98688-0.35955-0.1196-0.10353-0.21604-0.20676-0.28857-0.25838-0.12654-0.10353-0.11111-0.2578-0.0571-0.2578 0.08411 0.0117 0.09953 0.10411 0.15354 0.15514 0.07407 0.051 0.16591 0.1534 0.27853 0.25693 0.22452 0.15427 0.52469 0.36034 0.89969 0.36034 0.37423 0 0.8125-0.20589 1.0787-0.35958 0.15045-0.10411 0.34336-0.2578 0.5-0.36034 0.12036-0.10557 0.11496-0.20676 0.21528-0.20676 0.09953 0.0117 0.02625 0.10352-0.11341 0.25692-0.13966 0.10411-0.35571 0.25838-0.5324 0.36112v-7.7e-4zm-0.83487-1.2222v-0.0175c-0.0047-0.0146 0.0099-0.0324 0.02246-0.0385 0.0571-0.0332 0.13888-0.0204 0.20061 3e-3 0.04861 0 0.12345 0.0516 0.11575 0.10411-0.0047 0.0379-0.06559 0.051-0.10417 0.051-0.04243 0-0.07098-0.0332-0.10881-0.0525-0.04013-0.0146-0.11266-6e-3 -0.12578-0.0502zm-0.42515 0c-0.01546 0.0449-0.0872 0.0379-0.12808 0.051-0.03628 0.0204-0.06635 0.0525-0.10726 0.0525-0.03934 0-0.10108-0.0146-0.10572-0.0525-7e-3 -0.051 0.06789-0.10265 0.11575-0.10265 0.0625-0.0233 0.14196-0.0362 0.19985-3e-3 0.01458 6e-3 0.02771 0.0233 0.02304 0.0385v0.0175h0.0023z" stroke-width=".7716"/>
+ </clipPath>
+ </defs>
+ <metadata>
+ <rdf:RDF>
+ <cc:Work rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
+ <dc:title/>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g transform="translate(0 -270.54)" stroke-width=".27763">
+ <rect y="270.54" width="26.458" height="26.458" fill="#fcc624"/>
+ <rect transform="matrix(1 0 0 1 1.6321 -.0051893)" x="-1.4211e-14" y="270.54" width="26.458" height="26.458" clip-path="url(#clipPath1114)" fill="#ffffff"/>
+ </g>
+</svg>
diff --git a/docs/resources/macos.svg b/docs/resources/macos.svg new file mode 100644 index 0000000..1f4e007 --- /dev/null +++ b/docs/resources/macos.svg @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg width="100" height="100" version="1.1" viewBox="0 0 26.458333 26.458334" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+ <metadata>
+ <rdf:RDF>
+ <cc:Work rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
+ <dc:title/>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g transform="translate(0 -270.54)">
+ <rect x="-1.4211e-14" y="270.54" width="26.458" height="26.458" fill="#2b2e34" stroke-width=".27763"/>
+ <path class="st0" d="m8.6203 286.09h-0.51648v-1.9073c0-0.70227-0.24783-1.0534-0.74361-1.0534-0.11487 0-0.22034 0.0241-0.31672 0.0725-0.09597 0.0483-0.18014 0.11357-0.25133 0.19624-0.07098 0.0827-0.12617 0.17665-0.16536 0.28217-0.03899 0.10551-0.05899 0.21581-0.05899 0.33046v2.0794h-0.51627v-2.0311c0-0.27543-0.05999-0.49929-0.17906-0.67138-0.11937-0.17209-0.29602-0.25823-0.53017-0.25823-0.11917 0-0.22954 0.0263-0.33042 0.0792-0.10097 0.0529-0.18824 0.12401-0.26173 0.21342-0.07398 0.0894-0.13077 0.19058-0.17216 0.30306-0.04099 0.11247-0.06198 0.22603-0.06198 0.3409v2.0241h-0.51628v-2.4579c0-0.13315 0-0.27195-0.01-0.41663 0-0.14467-0.012-0.295-0.021-0.45098h0.46149v0.54388h0.04798c0.23414-0.40857 0.57835-0.61285 1.0327-0.61285 0.22044 0 0.4121 0.0598 0.57506 0.17905 0.16296 0.11944 0.27863 0.28239 0.34761 0.48885h0.014c0.11927-0.22039 0.27193-0.38661 0.45779-0.49908 0.18594-0.11247 0.3981-0.16882 0.63703-0.16882 0.32582 0 0.58626 0.12509 0.7814 0.37528 0.19515 0.25019 0.29263 0.59806 0.29263 1.0432v1.976zm2.6857 0-0.04799-0.42684h-0.02099c-0.22504 0.33503-0.56006 0.50255-1.0054 0.50255-0.14226 0-0.27323-0.0231-0.3925-0.0688-0.11947-0.0459-0.22274-0.11117-0.30982-0.19624-0.08698-0.0851-0.15596-0.18471-0.20644-0.29958-0.05099-0.11465-0.07598-0.24105-0.07598-0.37876 0-0.404 0.16746-0.71032 0.50257-0.91917 0.33502-0.20886 0.8217-0.31328 1.4595-0.31328v-0.0757c0-0.54606-0.25473-0.81931-0.76431-0.81931-0.31671 0-0.59674 0.0803-0.83989 0.24104l-0.12407-0.3581c0.29373-0.18818 0.64024-0.28238 1.0397-0.28238 0.80779 0 1.2118 0.44294 1.2118 1.3288v1.274c0 0.16055 0 0.30653 0.01 0.43728 0.01 0.13098 0.02 0.24911 0.03799 0.35462h-0.47518zm-0.08898-1.7213h-0.10338c-0.89048 0-1.3358 0.26172-1.3358 0.78495 0 0.20667 0.05498 0.36026 0.16536 0.46143 0.11007 0.10094 0.24773 0.15141 0.41309 0.15141 0.10558 0 0.20996-0.0183 0.31332-0.0551 0.10328-0.0368 0.19516-0.0883 0.27543-0.1549 0.07998-0.0666 0.14577-0.14793 0.19616-0.24431 0.05099-0.0964 0.07598-0.20428 0.07598-0.3235zm3.5875-1.081c-0.20215-0.11031-0.43619-0.16534-0.70232-0.16534-0.18816 0-0.35591 0.0333-0.50278 0.0999s-0.27083 0.15838-0.3718 0.27542c-0.10088 0.11705-0.17906 0.25585-0.23404 0.41663-0.05499 0.16056-0.08298 0.33503-0.08298 0.52322 0 0.19275 0.02899 0.36962 0.08598 0.53018 0.05698 0.16056 0.13767 0.29718 0.24103 0.40966 0.10308 0.11247 0.22604 0.19972 0.36831 0.26171 0.14227 0.062 0.30062 0.0929 0.47518 0.0929 0.24774 0 0.49338-0.055 0.73682-0.16534l0.10307 0.39922c-0.25713 0.12857-0.56906 0.19275-0.93626 0.19275-0.24353 0-0.46368-0.0403-0.66123-0.12053-0.19724-0.0803-0.3672-0.19514-0.50947-0.34417-0.14227-0.14924-0.25123-0.32699-0.32702-0.53367-0.07598-0.20667-0.11357-0.43837-0.11357-0.69552 0-0.26171 0.04299-0.50037 0.12727-0.71619 0.08498-0.21559 0.20324-0.40161 0.35461-0.5576 0.15147-0.15598 0.33401-0.27782 0.54736-0.36484 0.21344-0.0873 0.44868-0.13096 0.70582-0.13096 0.33501 0 0.61044 0.0598 0.82629 0.17904zm4.5584 0.43381c0 0.36266-0.04899 0.69312-0.14816 0.9914-0.09898 0.29848-0.23864 0.55542-0.42009 0.77123-0.18126 0.21582-0.3995 0.38333-0.65424 0.50256-0.25474 0.11922-0.53826 0.17904-0.85018 0.17904-0.29853 0-0.57156-0.0585-0.8193-0.17557-0.24803-0.11705-0.46148-0.28-0.64053-0.48884-0.17906-0.20886-0.31782-0.45687-0.4166-0.74361-0.09898-0.28674-0.14797-0.60241-0.14797-0.94681 0-0.35787 0.05199-0.68725 0.15497-0.98792 0.10328-0.30065 0.24663-0.55759 0.43029-0.77123 0.18366-0.21342 0.4027-0.37984 0.65743-0.49906 0.25504-0.11922 0.53387-0.17906 0.83699-0.17906 0.30283 0 0.57935 0.0575 0.82949 0.17209 0.25024 0.11487 0.46258 0.27543 0.63704 0.4821 0.17446 0.20668 0.30982 0.45448 0.4062 0.74361 0.09598 0.28912 0.14466 0.60589 0.14466 0.95007zm-0.55786 0.0276c0-0.27542-0.03699-0.53127-0.11027-0.76776-0.07398-0.23626-0.17556-0.44293-0.30632-0.61959-0.13097-0.17665-0.28693-0.31437-0.46819-0.41314-0.18126-0.0986-0.3822-0.14794-0.60244-0.14794-0.22494 0-0.43029 0.0494-0.61634 0.14794-0.18596 0.0988-0.34411 0.23627-0.47508 0.41314-0.13097 0.17666-0.23304 0.3879-0.30652 0.63352-0.07399 0.24562-0.11008 0.513-0.11008 0.80213 0 0.27086 0.03699 0.52453 0.11008 0.7608 0.07298 0.23648 0.17556 0.44184 0.30652 0.61633 0.13077 0.17448 0.28802 0.31219 0.47168 0.41314 0.18356 0.10094 0.3855 0.15142 0.60584 0.15142 0.22494 0 0.4303-0.0505 0.61634-0.15142 0.18606-0.10095 0.34422-0.24105 0.47518-0.42011 0.13097-0.17904 0.23164-0.38898 0.30302-0.63004 0.07098-0.24105 0.10657-0.50385 0.10657-0.78842zm3.6841 1.0947c0 0.19732-0.03699 0.37768-0.11027 0.54063-0.07298 0.16295-0.17796 0.30196-0.31332 0.41661-0.13527 0.11487-0.29933 0.2032-0.49228 0.26521-0.19275 0.062-0.4086 0.0929-0.64724 0.0929-0.47758 0-0.85608-0.0986-1.1361-0.29609l0.14446-0.4338c0.30742 0.19275 0.64944 0.28912 1.026 0.28912 0.31672 0 0.56236-0.0757 0.73681-0.22712 0.17456-0.15142 0.26173-0.35331 0.26173-0.6059 0-0.23409-0.06798-0.42336-0.20315-0.56803-0.13557-0.14446-0.35921-0.27651-0.67143-0.39595-0.7941-0.29827-1.1911-0.73447-1.1911-1.3082 0-0.17884 0.03499-0.34418 0.10657-0.4956 0.07098-0.15142 0.17106-0.28239 0.29962-0.39247s0.28103-0.19493 0.45768-0.25475c0.17666-0.0596 0.36831-0.0894 0.57506-0.0894 0.3992 0 0.72512 0.0736 0.97765 0.22038l-0.15836 0.42684c-0.22494-0.14227-0.50497-0.21341-0.83999-0.21341-0.26623 0-0.48208 0.0666-0.64724 0.19971-0.16536 0.13314-0.24774 0.3098-0.24774 0.53018 0 0.10552 0.015 0.19972 0.04499 0.28239 0.02999 0.0827 0.07898 0.16056 0.14816 0.23409 0.06898 0.0736 0.16186 0.14359 0.27883 0.20994 0.11707 0.0666 0.26523 0.13663 0.44409 0.20995 0.20645 0.0827 0.3833 0.171 0.53017 0.26519 0.14686 0.0942 0.26733 0.19624 0.36161 0.30632 0.09398 0.11031 0.16186 0.23083 0.20315 0.36158 0.04099 0.1301 0.06198 0.27346 0.06198 0.42967z" fill="#ffffff" stroke-width=".0021756"/>
+ </g>
+</svg>
diff --git a/docs/resources/opensuse.svg b/docs/resources/opensuse.svg new file mode 100644 index 0000000..cc80d5e --- /dev/null +++ b/docs/resources/opensuse.svg @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg width="100" height="100" version="1.1" viewBox="0 0 26.458333 26.458334" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+ <metadata>
+ <rdf:RDF>
+ <cc:Work rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
+ <dc:title/>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g transform="translate(0 -270.54)">
+ <rect x="-1.4211e-14" y="270.54" width="26.458" height="26.458" fill="#73ba25" stroke-width=".27763"/>
+ <path d="m11.815 286.7 0.0272-3e-3 0.0049-0.0319c-0.0073-0.0247-0.02355-0.0471-0.04953-0.35762-0.02172-0.27466-0.06577-1.0274 0.32276-1.401 0.15042-0.14554 0.38102-0.27545 0.5621-0.31703 0.74439-0.17742 1.6173-0.0547 2.442 0.87606 0.4267 0.4812 0.63517 0.70041 0.73992 0.79883l0.03613 0.0321 0.04324 0.0311c0.03451 0.0186 1.4185 0.64 1.4185 0.64l0.02822-7e-3 3.91e-4 -0.0289c-0.0087-0.0101-0.87694-1.1044-0.72307-2.0056 0.1222-0.71783 0.70805-0.65327 1.5178-0.56376 0.2645 0.0295 0.56616 0.0636 0.87735 0.0701 0.87024 5e-3 1.8079-0.1507 2.386-0.39724 0.37351-0.15901 0.61183-0.26417 0.76123-0.39684 0.054-0.0434 0.08161-0.11426 0.11063-0.18971l0.0203-0.0507c0.02416-0.061 0.05948-0.1909 0.07491-0.2614 0.0071-0.0315 0.01035-0.065-0.01197-0.082l-0.08039 0.0145c-0.25293 0.14871-0.8873 0.4309-1.4809 0.44219-0.73586 0.0149-2.2179-0.722-2.3728-0.79982l-0.01462-0.0172c-0.03694-0.0863-0.25882-0.59941-0.30652-0.70793 1.0674 0.68555 1.9518 1.0646 2.6294 1.1236 0.75454 0.0653 1.342-0.33585 1.5939-0.50754 0.04913-0.0321 0.08648-0.0584 0.1015-0.0642l0.01624-0.0257c-0.04162-0.25821-0.43563-1.5089-0.73342-1.8099-0.08242-0.082-0.14859-0.16237-0.28196-0.23841-1.0781-0.61309-3.6369-0.983-3.7571-1l-0.0203 6e-3 -0.0075 0.0178s-0.01035 0.51764-0.01117 0.57506c-0.26227-0.085-2.1621-0.68358-3.943-0.74378-1.5101-0.0521-3.7091-0.24218-6.6238 1.5054l-0.08627 0.0527c-1.371 0.83467-2.3174 1.863-2.8123 3.0587-0.15509 0.37585-0.36418 1.225-0.15793 2.0234 0.08972 0.34912 0.25618 0.69941 0.48008 1.0139 0.50607 0.70932 1.3552 1.18 2.2707 1.2596 1.2913 0.11227 2.2701-0.45348 2.6176-1.5131 0.23933-0.73109 0-1.8042-0.91673-2.3515-0.74581-0.44535-1.548-0.34357-2.0131-0.044-0.40416 0.26119-0.63294 0.66654-0.62888 1.1123 0.0093 0.79011 0.70764 1.2101 1.2092 1.2111 0.14616 0 0.29231-0.0244 0.45735-0.077 0.05846-0.0176 0.11449-0.039 0.17498-0.0756l0.01908-0.0115 0.01259-8e-3 -0.0049 2e-3c0.11449-0.0754 0.18391-0.1992 0.18391-0.33207 0-0.036-0.0055-0.0731-0.01604-0.1101-0.05887-0.19961-0.26146-0.32061-0.47156-0.28377l-0.02842 6e-3 -0.03857 0.0121-0.05582 0.0182c-0.1155 0.0283-0.20218 0.0301-0.22045 0.0309-0.05927-4e-3 -0.34794-0.0881-0.34794-0.39684v-4e-3c6.12e-4 -0.11308 0.04709-0.19288 0.07288-0.23625 0.08911-0.13723 0.33535-0.27248 0.66847-0.24357 0.43583 0.0364 0.75007 0.25446 0.95814 0.66616 0.19366 0.38298 0.14311 0.85327-0.13032 1.1986-0.271 0.34218-0.75352 0.48694-1.3962 0.41902-0.64776-0.0695-1.195-0.43328-1.5018-0.99942-0.30003-0.55289-0.31667-1.2089-0.04243-1.7127 0.65588-1.207 1.8938-1.1943 2.5728-1.0806 1.0052 0.1701 2.1479 1.0749 2.5539 2.1188 0.06516 0.16634 0.09845 0.29842 0.12667 0.41823l0.04405 0.18079 1.1352 0.5408zm7.9773-5.8922c-0.21416 0.19426-0.33616 0.45902-0.34651 0.74418-0.0199 0.58813 0.45309 1.0832 1.0554 1.1054 0.29414 0.01 0.57204-0.0913 0.7858-0.28653 0.21376-0.19426 0.33576-0.45863 0.34692-0.74319 0.0203-0.58833-0.45268-1.0846-1.0566-1.106-0.29211-0.01-0.57123 0.0915-0.78498 0.28613" clip-rule="evenodd" fill="#ffffff" fill-rule="evenodd" stroke-width=".20049"/>
+ </g>
+</svg>
diff --git a/docs/resources/tvos.svg b/docs/resources/tvos.svg new file mode 100644 index 0000000..5650740 --- /dev/null +++ b/docs/resources/tvos.svg @@ -0,0 +1 @@ +<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100" viewBox="0 0 26.458 26.458"><path d="M0 0h26.458v26.458H0z" fill="#2b2e34"/><g fill="#fff"><path d="M7.562 11.208v.962H8.7v.433H7.562v1.84q0 .415.112.533.115.118.463.118h.572v.466h-.572q-.645 0-.9-.24-.245-.242-.245-.878v-1.84h-.4v-.433h.4v-.962zm1.483.962h.6l1.06 2.845 1.06-2.845h.6l-1.27 3.4h-.757z"/><path d="M14.7 10.83c-.303 0-.582.06-.837.18s-.474.286-.657.5-.327.47-.43.77-.155.63-.155.988c0 .344.05.66.148.947a2.26 2.26 0 0 0 .417.744c.18.21.392.372.64.49s.52.176.82.176a1.98 1.98 0 0 0 .85-.179c.255-.12.473-.287.654-.503s.32-.473.42-.77a3.13 3.13 0 0 0 .148-.992 3 3 0 0 0-.145-.95c-.096-.29-.232-.537-.406-.744a1.81 1.81 0 0 0-.637-.482c-.25-.115-.527-.172-.83-.172zm3.986.007c-.207 0-.398.03-.575.09a1.37 1.37 0 0 0-.458.255 1.16 1.16 0 0 0-.3.393c-.072.15-.106.317-.106.496 0 .574.397 1 1.19 1.308.312.12.536.25.67.396s.203.334.203.568c0 .253-.087.455-.26.606s-.42.227-.737.227c-.377 0-.72-.096-1.026-.29l-.144.434c.28.197.658.296 1.136.296a2.11 2.11 0 0 0 .648-.092 1.42 1.42 0 0 0 .492-.266c.135-.115.24-.254.314-.417s.1-.343.1-.54h.001c0-.156-.02-.3-.062-.43s-.11-.25-.203-.362a1.63 1.63 0 0 0-.362-.306c-.147-.094-.324-.182-.53-.265-.18-.073-.327-.143-.444-.2s-.2-.137-.28-.2a.68.68 0 0 1-.148-.234c-.03-.083-.045-.177-.045-.282 0-.22.083-.397.248-.53s.38-.2.647-.2c.335 0 .615.07.84.213l.158-.427c-.253-.147-.58-.22-.978-.22zm-4.014.42a1.24 1.24 0 0 1 .603.148c.18.1.337.237.468.413s.232.383.306.62.1.492.1.768a2.78 2.78 0 0 1-.106.788c-.07.24-.172.45-.303.63s-.29.32-.475.42a1.27 1.27 0 0 1-.617.151c-.22 0-.422-.05-.606-.15a1.47 1.47 0 0 1-.472-.413 2 2 0 0 1-.306-.617 2.56 2.56 0 0 1-.11-.761 2.77 2.77 0 0 1 .11-.802 2.03 2.03 0 0 1 .306-.634 1.41 1.41 0 0 1 .475-.413c.186-.098.392-.148.617-.148z"/></g></svg>
\ No newline at end of file diff --git a/docs/resources/ubuntu.svg b/docs/resources/ubuntu.svg new file mode 100644 index 0000000..d72e496 --- /dev/null +++ b/docs/resources/ubuntu.svg @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg width="100" height="100" version="1.1" viewBox="0 0 26.458333 26.458334" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+ <metadata>
+ <rdf:RDF>
+ <cc:Work rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
+ <dc:title/>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <rect x="-1.4211e-14" y="8.5449e-6" width="26.458" height="26.458" fill="#dd4814" stroke-width=".27763"/>
+ <circle cx="13.229" cy="13.229" r="9.2604" fill="#ffffff" stroke-width=".065339"/>
+ <g transform="matrix(.87503 0 0 .87503 1.6534 -235.08)" fill="#dd4814" stroke-width=".074671">
+ <circle cx="6.0325" cy="283.77" r="1.4129"/>
+ <path d="m9.8237 288.88c-1.2365-0.82612-2.1564-2.0891-2.5385-3.5684 0.44639-0.36374 0.73151-0.91772 0.73151-1.5387s-0.28512-1.175-0.73151-1.5387c0.38207-1.4793 1.3019-2.7423 2.5385-3.5684l1.033 1.7304c-1.0611 0.74683-1.7551 1.9802-1.7551 3.3767 0 1.3966 0.69392 2.6299 1.7551 3.3767z"/>
+ <circle transform="rotate(120)" cx="231.94" cy="-153.34" r="1.4129"/>
+ <path d="m10.509 278.27c1.3337-0.6578 2.8874-0.82293 4.3596-0.41416 0.0918 0.56846 0.42901 1.0924 0.96681 1.4029s1.1601 0.34057 1.6983 0.13585c1.0901 1.0705 1.7239 2.4987 1.8211 3.9826l-2.0151 0.0294c-0.1162-1.2924-0.83735-2.51-2.0468-3.2083-1.2094-0.69828-2.6245-0.714-3.8019-0.16843z"/>
+ <circle transform="rotate(240)" cx="-259.56" cy="-130.43" r="1.4129"/>
+ <path d="m19.355 284.17c-0.09718 1.4839-0.73103 2.912-1.8211 3.9826-0.5382-0.20472-1.1605-0.17465-1.6983 0.13585s-0.87501 0.83441-0.96681 1.4029c-1.4722 0.40877-3.0259 0.24364-4.3596-0.41416l0.98207-1.7598c1.1773 0.54557 2.5924 0.52985 3.8019-0.16843 1.2094-0.69827 1.9306-1.9159 2.0468-3.2083z"/>
+ </g>
+</svg>
diff --git a/docs/resources/windows.svg b/docs/resources/windows.svg new file mode 100644 index 0000000..baded13 --- /dev/null +++ b/docs/resources/windows.svg @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg width="100" height="100" version="1.1" viewBox="0 0 26.458333 26.458334" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+ <metadata>
+ <rdf:RDF>
+ <cc:Work rdf:about="">
+ <dc:format>image/svg+xml</dc:format>
+ <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
+ <dc:title/>
+ </cc:Work>
+ </rdf:RDF>
+ </metadata>
+ <g transform="translate(0 -270.54)">
+ <rect x="-1.4211e-14" y="270.54" width="26.458" height="26.458" fill="#0078d7" stroke-width=".27763"/>
+ <path d="m3.9688 277.17 7.5241-1.041v7.2933h-7.5241m8.4494-7.4099 10.071-1.504v8.7974h-10.071m-8.4494 0.92604h7.5241v7.2934l-7.5241-1.0434m8.4494-6.25h10.071v8.7974l-9.9549-1.3898" fill="#ffffff" stroke-width=".7717"/>
+ </g>
+</svg>
|
