--- /dev/null
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+ <link rel="shortcut icon" href="../img/favicon.ico">
+ <title>Static analysis - Shaarli Documentation</title>
+ <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
+
+ <link rel="stylesheet" href="../css/theme.css" type="text/css" />
+ <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
+ <link rel="stylesheet" href="../css/highlight.css">
+ <link href="../github-markdown.css" rel="stylesheet">
+
+ <script>
+ // Current page data
+ var mkdocs_page_name = "Static analysis";
+ var mkdocs_page_input_path = "Static-analysis.md";
+ var mkdocs_page_url = "/Static-analysis/";
+ </script>
+
+ <script src="../js/jquery-2.1.1.min.js"></script>
+ <script src="../js/modernizr-2.8.3.min.js"></script>
+ <script type="text/javascript" src="../js/highlight.pack.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+ <div class="wy-side-nav-search">
+ <a href=".." class="icon icon-home"> Shaarli Documentation</a>
+ <div role="search">
+ <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ </form>
+</div>
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+ <ul class="current">
+
+
+ <li class="toctree-l1">
+
+ <a class="" href="..">Home</a>
+ </li>
+
+ <li class="toctree-l1">
+
+ <span class="caption-text">Setup</span>
+ <ul class="subnav">
+ <li class="">
+
+ <a class="" href="../Download-and-Installation/">Download and Installation</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Server-requirements/">Server requirements</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Server-configuration/">Server configuration</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Server-security/">Server security</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Plugins/">Plugins</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="toctree-l1">
+
+ <span class="caption-text">Docker</span>
+ <ul class="subnav">
+ <li class="">
+
+ <a class="" href="../Docker-101/">Docker 101</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Shaarli-images/">Shaarli images</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Docker-resources/">Docker resources</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="toctree-l1">
+
+ <span class="caption-text">Usage</span>
+ <ul class="subnav">
+ <li class="">
+
+ <a class="" href="../Features/">Features</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Bookmarklet/">Bookmarklet</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Firefox-share/">Firefox share</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../RSS-feeds/">RSS feeds</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../REST-API/">REST API</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="toctree-l1">
+
+ <span class="caption-text">How To</span>
+ <ul class="subnav">
+ <li class="">
+
+ <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Datastore-hacks/">Datastore hacks</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="toctree-l1">
+
+ <a class="" href="../Troubleshooting/">Troubleshooting</a>
+ </li>
+
+ <li class="toctree-l1">
+
+ <span class="caption-text">Development</span>
+ <ul class="subnav">
+ <li class="">
+
+ <a class="" href="../Development-guidelines/">Development guidelines</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../GnuPG-signature/">GnuPG signature</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Coding-guidelines/">Coding guidelines</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Directory-structure/">Directory structure</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Plugin-System/">Plugin System</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Release-Shaarli/">Release Shaarli</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Security/">Security</a>
+ </li>
+ <li class=" current">
+
+ <a class="current" href="./">Static analysis</a>
+ <ul class="subnav">
+
+ <li class="toctree-l3"><a href="#wip">WIP</a></li>
+
+ <ul>
+
+ <li><a class="toctree-l4" href="#usage">Usage</a></li>
+
+ </ul>
+
+
+ </ul>
+ </li>
+ <li class="">
+
+ <a class="" href="../Theming/">Theming</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Unit-tests/">Unit tests</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="toctree-l1">
+
+ <span class="caption-text">About</span>
+ <ul class="subnav">
+ <li class="">
+
+ <a class="" href="../FAQ/">FAQ</a>
+ </li>
+ <li class="">
+
+ <a class="" href="../Community-&-Related-software/">Community & Related software</a>
+ </li>
+ </ul>
+ </li>
+
+ </ul>
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="..">Shaarli Documentation</a>
+ </nav>
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="..">Docs</a> »</li>
+
+
+
+ <li>Development »</li>
+
+
+
+ <li>Static analysis</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Static-analysis.md"
+ class="icon icon-github"> Edit on GitHub</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+ <div role="main">
+ <div class="section">
+
+ <h2 id="wip">WIP</h2>
+<p>This topic is currently being discussed here:
+- <a href="https://github.com/shaarli/Shaarli/issues/95">Fix coding style (static analysis)</a> (#95)
+- <a href="https://github.com/shaarli/Shaarli/issues/130">Continuous Integration tools & features</a> (#130)</p>
+<h3 id="usage">Usage</h3>
+<p>Static analysis tools can be installed with Composer, and used through Shaarli's <a href="https://github.com/shaarli/Shaarli/blob/master/Makefile">Makefile</a>.</p>
+<p>For an overview of the available features, see:
+- <a href="https://github.com/shaarli/Shaarli/pull/124">Code quality: Makefile to run static code checkers</a> (#124)
+- <a href="https://github.com/shaarli/Shaarli/pull/276">Run PHPCS against different coding standards</a> (#276)</p>
+
+ </div>
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../Theming/" class="btn btn-neutral float-right" title="Theming">Next <span class="icon icon-circle-arrow-right"></span></a>
+
+
+ <a href="../Security/" class="btn btn-neutral" title="Security"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <!-- Copyright etc -->
+
+ </div>
+
+ Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+ <div class="rst-versions" role="note" style="cursor: pointer">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+
+ <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
+
+
+ <span><a href="../Security/" style="color: #fcfcfc;">« Previous</a></span>
+
+
+ <span style="margin-left: 15px"><a href="../Theming/" style="color: #fcfcfc">Next »</a></span>
+
+ </span>
+</div>
+ <script src="../js/theme.js"></script>
+
+</body>
+</html>
projects / github / shaarli / Shaarli.git / blobdiff