/usr/share/doc/copyq/html/fixing-bugs.html is in copyq-doc 3.2.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | <!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 name="viewport" content="width=device-width, initial-scale=1.0">
<title>Fixing Bugs and Adding Features — CopyQ documentation</title>
<link rel="shortcut icon" href="_static/icon_32x32.png"/>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="CopyQ documentation" href="index.html"/>
<link rel="next" title="Source Code Overview" href="source-code-overview.html"/>
<link rel="prev" title="Build from Source Code" href="build-source-code.html"/>
<script src="_static/js/modernizr.min.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">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> CopyQ
<img src="_static/icon_64x64.png" class="logo" />
</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" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">The Basics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="basic-usage.html">Basic Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="tabs-and-items.html">Tabs and Items</a></li>
<li class="toctree-l1"><a class="reference internal" href="keyboard.html">Keyboard</a></li>
<li class="toctree-l1"><a class="reference internal" href="images.html">Images</a></li>
<li class="toctree-l1"><a class="reference internal" href="tags.html">Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ - Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>
<p class="caption"><span class="caption-text">Advanced Topics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="command-line.html">Command Line</a></li>
<li class="toctree-l1"><a class="reference internal" href="sessions.html">Sessions</a></li>
<li class="toctree-l1"><a class="reference internal" href="pin-items.html">Pin Items</a></li>
<li class="toctree-l1"><a class="reference internal" href="password-protection.html">Password Protection</a></li>
<li class="toctree-l1"><a class="reference internal" href="synchronize.html">Synchronize with Documents</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing-commands-and-adding-functionality.html">Writing Commands and Adding Functionality</a></li>
<li class="toctree-l1"><a class="reference internal" href="scripting.html">Scripting</a></li>
<li class="toctree-l1"><a class="reference internal" href="command-examples.html">Command Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="backup.html">Backup</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing-raw-data.html">Writing Raw Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="scripting-api.html">Scripting API</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="build-source-code.html">Build from Source Code</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Fixing Bugs and Adding Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#making-changes">Making Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-the-debug-version">Build the Debug Version</a></li>
<li class="toctree-l2"><a class="reference internal" href="#run-tests">Run Tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="source-code-overview.html">Source Code Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="translations.html">Translations</a></li>
<li class="toctree-l1"><a class="reference internal" href="text-encoding.html">Text Encoding</a></li>
<li class="toctree-l1"><a class="reference internal" href="customize-and-build-the-windows-installer.html">Customize and Build the Windows Installer</a></li>
</ul>
</div>
</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="index.html">CopyQ</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="index.html">Docs</a> »</li>
<li>Fixing Bugs and Adding Features</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/fixing-bugs.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="fixing-bugs-and-adding-features">
<h1>Fixing Bugs and Adding Features<a class="headerlink" href="#fixing-bugs-and-adding-features" title="Permalink to this headline">¶</a></h1>
<p>This page describes how to build, fix and improve the source code.</p>
<div class="section" id="making-changes">
<h2>Making Changes<a class="headerlink" href="#making-changes" title="Permalink to this headline">¶</a></h2>
<p>Pull requests are welcome at <a class="reference external" href="https://github.com/hluk/CopyQ">github project
page</a>.</p>
<p>For more info see <a class="reference external" href="https://help.github.com/articles/creating-a-pull-request-from-a-fork/">Creating a pull request from a fork</a>.</p>
<p>Try to keep the code style consistent with the existing code.</p>
</div>
<div class="section" id="build-the-debug-version">
<h2>Build the Debug Version<a class="headerlink" href="#build-the-debug-version" title="Permalink to this headline">¶</a></h2>
<div class="highlight-bash"><div class="highlight"><pre><span></span>mkdir build
<span class="nb">cd</span> build
cmake -DCMAKE_BUILD_TYPE<span class="o">=</span>Debug -DWITH_TESTS<span class="o">=</span>ON ..
make
</pre></div>
</div>
</div>
<div class="section" id="run-tests">
<h2>Run Tests<a class="headerlink" href="#run-tests" title="Permalink to this headline">¶</a></h2>
<p>You can run automated tests if the application is built either in debug
mode, with CMake flag <code class="docutils literal"><span class="pre">-DWITH_TESTS=ON</span></code> or QMake flag
<code class="docutils literal"><span class="pre">CONFIG+=tests</span></code> (releases are usually build with tests).</p>
<p>Run the tests with following command.</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>copyq tests
</pre></div>
</div>
<p>This command will execute all test cases in new special CopyQ session so
that user configuration, tabs and items are not modified. It’s better to
close any other CopyQ session before running tests since they can affect
test results.</p>
<p>While running tests there must be <strong>no keyboard and mouse interaction</strong>.
Preferably you can execute the tests in separate virtual environment. On
Linux you can run the tests on virtual X11 server with <code class="docutils literal"><span class="pre">xvfb-run</span></code>.</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>xvfb-run sh -c <span class="s1">'openbox & sleep 1; copyq tests'</span>
</pre></div>
</div>
<p>Test invocation examples:</p>
<ul class="simple">
<li>Print help for tests: <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">tests</span> <span class="pre">--help</span></code></li>
<li>Run specific tests: <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">tests</span> <span class="pre">commandHelp</span> <span class="pre">commandVersion</span></code></li>
<li>Run specific tests for a plugin: <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">tests</span> <span class="pre">'PLUGINS:pinned'</span> <span class="pre">isPinned</span></code></li>
<li>Run tests only for specific plugins: <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">tests</span> <span class="pre">'PLUGINS:pinned|tags'</span></code></li>
<li>List tests: <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">tests</span> <span class="pre">-functions</span></code></li>
<li>List tests for a plugin: <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">tests</span> <span class="pre">PLUGINS:tags</span> <span class="pre">-functions</span></code></li>
<li>Less verbose tests: <code class="docutils literal"><span class="pre">copyq</span> <span class="pre">tests</span> <span class="pre">-silent</span></code></li>
<li>Slower GUI tests: <code class="docutils literal"><span class="pre">COPYQ_TESTS_KEYS_WAIT=1000</span> <span class="pre">COPYQ_TESTS_KEY_DELAY=50</span> <span class="pre">copyq</span> <span class="pre">tests</span> <span class="pre">editItems</span></code></li>
</ul>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="source-code-overview.html" class="btn btn-neutral float-right" title="Source Code Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="build-source-code.html" class="btn btn-neutral" title="Build from Source Code" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Lukas Holecek.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</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>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|