[github/shaarli/Shaarli.git] / doc / html / Static-analysis / index.html

<!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="../Various-hacks/">Various 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>
      &nbsp;
    </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> &raquo;</li>
    
      
        
          <li>Development &raquo;</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 &amp; 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;">&laquo; Previous</a></span>
      
      
        <span style="margin-left: 15px"><a href="../Theming/" style="color: #fcfcfc">Next &raquo;</a></span>
      
    </span>
</div>
    <script src="../js/theme.js"></script>

</body>
</html>
Commit	Line	Data
53ed6d7d	1	<!DOCTYPE html>
	2	<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
	3	<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
	4	<head>
	5	<meta charset="utf-8">
	6	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	7	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	8
	9
	10	<link rel="shortcut icon" href="../img/favicon.ico">
	11	<title>Static analysis - Shaarli Documentation</title>
	12	<link href='https://fonts.googleapis.com/css?family=Lato:400,700\|Roboto+Slab:400,700\|Inconsolata:400,700' rel='stylesheet' type='text/css'>
	13
	14	<link rel="stylesheet" href="../css/theme.css" type="text/css" />
	15	<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
	16	<link rel="stylesheet" href="../css/highlight.css">
	17	<link href="../github-markdown.css" rel="stylesheet">
	18
	19	<script>
	20	// Current page data
	21	var mkdocs_page_name = "Static analysis";
	22	var mkdocs_page_input_path = "Static-analysis.md";
	23	var mkdocs_page_url = "/Static-analysis/";
	24	</script>
	25
	26	<script src="../js/jquery-2.1.1.min.js"></script>
	27	<script src="../js/modernizr-2.8.3.min.js"></script>
	28	<script type="text/javascript" src="../js/highlight.pack.js"></script>
	29
	30	</head>
	31
	32	<body class="wy-body-for-nav" role="document">
	33
	34	<div class="wy-grid-for-nav">
	35
	36
	37	<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
	38	<div class="wy-side-nav-search">
	39	<a href=".." class="icon icon-home"> Shaarli Documentation</a>
	40	<div role="search">
	41	<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
	42	<input type="text" name="q" placeholder="Search docs" />
	43	</form>
	44	</div>
	45	</div>
	46
	47	<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
	48	<ul class="current">
	49
	50
	51	<li class="toctree-l1">
	52
	53	<a class="" href="..">Home</a>
	54	</li>
	55
	56	<li class="toctree-l1">
	57
	58	<span class="caption-text">Setup</span>
	59	<ul class="subnav">
	60	<li class="">
	61
	62	<a class="" href="../Download-and-Installation/">Download and Installation</a>
	63	</li>
	64	<li class="">
65
66	<a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
67	</li>
68	<li class="">
69
70	<a class="" href="../Server-requirements/">Server requirements</a>
71	</li>
72	<li class="">
73
74	<a class="" href="../Server-configuration/">Server configuration</a>
75	</li>
76	<li class="">
77
78	<a class="" href="../Server-security/">Server security</a>
79	</li>
80	<li class="">
81
82	<a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
83	</li>
84	<li class="">
85
86	<a class="" href="../Plugins/">Plugins</a>
87	</li>
88	</ul>
89	</li>
90
91	<li class="toctree-l1">
92
93	<span class="caption-text">Docker</span>
94	<ul class="subnav">
95	<li class="">
96
97	<a class="" href="../Docker-101/">Docker 101</a>
98	</li>
99	<li class="">
100
101	<a class="" href="../Shaarli-images/">Shaarli images</a>
102	</li>
103	<li class="">
104
105	<a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
106	</li>
107	<li class="">
108
109	<a class="" href="../Docker-resources/">Docker resources</a>
110	</li>
111	</ul>
112	</li>
113
114	<li class="toctree-l1">
115
116	<span class="caption-text">Usage</span>
117	<ul class="subnav">
118	<li class="">
119
120	<a class="" href="../Features/">Features</a>
121	</li>
122	<li class="">
123
124	<a class="" href="../Bookmarklet/">Bookmarklet</a>
125	</li>
126	<li class="">
127
128	<a class="" href="../Browsing-and-searching/">Browsing and searching</a>
129	</li>
130	<li class="">
131
132	<a class="" href="../Firefox-share/">Firefox share</a>
133	</li>
134	<li class="">
135
136	<a class="" href="../RSS-feeds/">RSS feeds</a>
137	</li>
138	<li class="">
139
140	<a class="" href="../REST-API/">REST API</a>
141	</li>
142	</ul>
143	</li>
144
145	<li class="toctree-l1">
146
147	<span class="caption-text">How To</span>
148	<ul class="subnav">
149	<li class="">
150
151	<a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
152	</li>
153	<li class="">
154
0433c688	155	<a class="" href="../Various-hacks/">Various hacks</a>
53ed6d7d	156	</li>
	157	</ul>
	158	</li>
	159
	160	<li class="toctree-l1">
	161
	162	<a class="" href="../Troubleshooting/">Troubleshooting</a>
	163	</li>
	164
	165	<li class="toctree-l1">
	166
	167	<span class="caption-text">Development</span>
	168	<ul class="subnav">
	169	<li class="">
	170
	171	<a class="" href="../Development-guidelines/">Development guidelines</a>
	172	</li>
	173	<li class="">
	174
	175	<a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
	176	</li>
	177	<li class="">
	178
	179	<a class="" href="../GnuPG-signature/">GnuPG signature</a>
	180	</li>
	181	<li class="">
	182
	183	<a class="" href="../Coding-guidelines/">Coding guidelines</a>
	184	</li>
	185	<li class="">
	186
	187	<a class="" href="../Directory-structure/">Directory structure</a>
	188	</li>
	189	<li class="">
	190
	191	<a class="" href="../3rd-party-libraries/">3rd party libraries</a>
	192	</li>
	193	<li class="">
	194
	195	<a class="" href="../Plugin-System/">Plugin System</a>
	196	</li>
	197	<li class="">
	198
	199	<a class="" href="../Release-Shaarli/">Release Shaarli</a>
	200	</li>
	201	<li class="">
	202
	203	<a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
	204	</li>
	205	<li class="">
	206
	207	<a class="" href="../Security/">Security</a>
	208	</li>
	209	<li class=" current">
	210
	211	<a class="current" href="./">Static analysis</a>
	212	<ul class="subnav">
	213
	214	<li class="toctree-l3"><a href="#wip">WIP</a></li>
	215
	216	<ul>
	217
	218	<li><a class="toctree-l4" href="#usage">Usage</a></li>
	219
220	</ul>
221
222
223	</ul>
224	</li>
225	<li class="">
226
227	<a class="" href="../Theming/">Theming</a>
228	</li>
229	<li class="">
230
231	<a class="" href="../Unit-tests/">Unit tests</a>
232	</li>
233	</ul>
234	</li>
235
236	<li class="toctree-l1">
237
238	<span class="caption-text">About</span>
239	<ul class="subnav">
240	<li class="">
241
242	<a class="" href="../FAQ/">FAQ</a>
243	</li>
244	<li class="">
245
246	<a class="" href="../Community-&-Related-software/">Community & Related software</a>
247	</li>
248	</ul>
249	</li>
250
251	</ul>
252	</div>
253
254	</nav>
255
256	<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
257
258
259	<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
260	<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
261	<a href="..">Shaarli Documentation</a>
262	</nav>
263
264
265	<div class="wy-nav-content">
266	<div class="rst-content">
267	<div role="navigation" aria-label="breadcrumbs navigation">
268	<ul class="wy-breadcrumbs">
269	<li><a href="..">Docs</a> »</li>
270
271
272
273	<li>Development »</li>
274
275
276
277	<li>Static analysis</li>
278	<li class="wy-breadcrumbs-aside">
279
280	<a href="https://github.com/shaarli/Shaarli/edit/master/docs/Static-analysis.md"
281	class="icon icon-github"> Edit on GitHub</a>
282
283	</li>
284	</ul>
285	<hr/>
286	</div>
287	<div role="main">
288	<div class="section">
289
290	<h2 id="wip">WIP</h2>
291	<p>This topic is currently being discussed here:
292	- <a href="https://github.com/shaarli/Shaarli/issues/95">Fix coding style (static analysis)</a> (#95)
293	- <a href="https://github.com/shaarli/Shaarli/issues/130">Continuous Integration tools & features</a> (#130)</p>
294	<h3 id="usage">Usage</h3>
295	<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>
296	<p>For an overview of the available features, see:
297	- <a href="https://github.com/shaarli/Shaarli/pull/124">Code quality: Makefile to run static code checkers</a> (#124)
298	- <a href="https://github.com/shaarli/Shaarli/pull/276">Run PHPCS against different coding standards</a> (#276)</p>
299
300	</div>
301	</div>
302	<footer>
303
304	<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
305
306	<a href="../Theming/" class="btn btn-neutral float-right" title="Theming">Next <span class="icon icon-circle-arrow-right"></span></a>
307
308
309	<a href="../Security/" class="btn btn-neutral" title="Security"><span class="icon icon-circle-arrow-left"></span> Previous</a>
310
311	</div>
312
313
314	<hr/>
315
316	<div role="contentinfo">
317	<!-- Copyright etc -->
318
319	</div>
320
321	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>.
322	</footer>
323
324	</div>
325	</div>
326
327	</section>
328
329	</div>
330
331	<div class="rst-versions" role="note" style="cursor: pointer">
332	<span class="rst-current-version" data-toggle="rst-current-version">
333
334	<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
335
336
337	<span><a href="../Security/" style="color: #fcfcfc;">« Previous</a></span>
338
339
340	<span style="margin-left: 15px"><a href="../Theming/" style="color: #fcfcfc">Next »</a></span>
341
342	</span>
343	</div>
344	<script src="../js/theme.js"></script>
345
346	</body>
347	</html>