Skip to content

Commit

Permalink
Merge pull request #7 from OCamlPro/z-2020-08-01-use-patches-only
Browse files Browse the repository at this point in the history
version 0.8.1
  • Loading branch information
lefessan authored Aug 2, 2020
2 parents 477855a + 7af3325 commit b08e253
Show file tree
Hide file tree
Showing 35 changed files with 12,465 additions and 81 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: b05dd1d657c11a530627f584a9eff892
config: 52c7d40600543a95223541956d3643be
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/about-and-thanks.doctree
Binary file not shown.
Binary file modified docs/.doctrees/basic-concepts.doctree
Binary file not shown.
Binary file modified docs/.doctrees/commands.doctree
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/.doctrees/f-a-q.doctree
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/.doctrees/installation.doctree
Binary file not shown.
Binary file modified docs/.doctrees/introduction.doctree
Binary file not shown.
Binary file modified docs/.doctrees/local-usage.doctree
Binary file not shown.
Binary file modified docs/.doctrees/repositories.doctree
Binary file not shown.
Binary file modified docs/.doctrees/sharing-packages.doctree
Binary file not shown.
37 changes: 37 additions & 0 deletions docs/_sources/f-a-q.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@

Frequently Asked Questions
==========================

This section will grow over time, and should gather replies to
Frequently Asked Questions.

The patch didn't apply correctly. What shall I do ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Most of the time, we didn't have time to test a patch that we made for
a version on other versions of the same package. It's often the case
that they will work without modification.

For a given version of a package, :code:`opam-bin` selects the patch
with the higest version less or equal to the package being installed.
Sometimes, it would be better to use the patch for the version just
higher. This is a good way to solve your problem.

For that, you will have to use a local version of the
:code:`relocation-patches` directory::

git clone git@github.com:OCamlPro/relocation-patches
opam bin config --patches-url file://$(pwd)/relocation-patches
cd relocation-patches/patches/$NAME/
cp $NEXT_VERSION.patch $VERSION.patch

Why not upstream patches to opam-repository ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Patches in the :code:`relocation-patches` repository should be
upstreamed to :code:`opam-repository` over time, but the problem is
that they should be applied to many versions of the same packages. For
example, the :code:`ocaml-variants` package contains tens of packages
for every version of OCaml. So, it would take a lot of work. Instead,
:code:`opam-bin` is able to automatically patch a range of versions
using a single patch.
1 change: 1 addition & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ the source package manager of OCaml.
sharing-packages
commands
repositories
f-a-q
about-and-thanks
Devel and Issues on Github <https://github.com/ocamlpro/opam-bin>

Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: 'z-2020-08-01-use-patches-only (fdd7e9d) (2020/08/02 13:20)',
VERSION: 'z-2020-08-01-use-patches-only (e9c9199) (2020/08/02 20:18)',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
Expand Down
10,369 changes: 10,365 additions & 4 deletions docs/_static/jquery.js

Large diffs are not rendered by default.

1,723 changes: 1,692 additions & 31 deletions docs/_static/underscore.js

Large diffs are not rendered by default.

11 changes: 6 additions & 5 deletions docs/about-and-thanks.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>About, Thanks and Funding &mdash; opam-bin z-2020-08-01-use-patches-only
(fdd7e9d
) (2020/08/02 13:20) documentation</title>
(e9c9199
) (2020/08/02 20:18) documentation</title>



Expand Down Expand Up @@ -39,7 +39,7 @@

<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Contributed Binary Repositories" href="repositories.html" />
<link rel="prev" title="Frequently Asked Questions" href="f-a-q.html" />
</head>

<body class="wy-body-for-nav">
Expand All @@ -64,7 +64,7 @@

<div class="version">
z-2020-08-01-use-patches-only
(fdd7e9d
(e9c9199
)
</div>

Expand Down Expand Up @@ -99,6 +99,7 @@
<li class="toctree-l1"><a class="reference internal" href="sharing-packages.html">Sharing Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="repositories.html">Contributed Binary Repositories</a></li>
<li class="toctree-l1"><a class="reference internal" href="f-a-q.html">Frequently Asked Questions</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">About, Thanks and Funding</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#about">About</a></li>
<li class="toctree-l2"><a class="reference internal" href="#thanks">Thanks</a></li>
Expand Down Expand Up @@ -215,7 +216,7 @@ <h2>Funding<a class="headerlink" href="#funding" title="Permalink to this headli
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">


<a href="repositories.html" class="btn btn-neutral float-left" title="Contributed Binary Repositories" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="f-a-q.html" class="btn btn-neutral float-left" title="Frequently Asked Questions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

Expand Down
7 changes: 4 additions & 3 deletions docs/basic-concepts.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Basic Concepts &mdash; opam-bin z-2020-08-01-use-patches-only
(fdd7e9d
) (2020/08/02 13:20) documentation</title>
(e9c9199
) (2020/08/02 20:18) documentation</title>



Expand Down Expand Up @@ -65,7 +65,7 @@

<div class="version">
z-2020-08-01-use-patches-only
(fdd7e9d
(e9c9199
)
</div>

Expand Down Expand Up @@ -106,6 +106,7 @@
<li class="toctree-l1"><a class="reference internal" href="sharing-packages.html">Sharing Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="repositories.html">Contributed Binary Repositories</a></li>
<li class="toctree-l1"><a class="reference internal" href="f-a-q.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="about-and-thanks.html">About, Thanks and Funding</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/ocamlpro/opam-bin">Devel and Issues on Github</a></li>
</ul>
Expand Down
7 changes: 4 additions & 3 deletions docs/commands.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Commands &mdash; opam-bin z-2020-08-01-use-patches-only
(fdd7e9d
) (2020/08/02 13:20) documentation</title>
(e9c9199
) (2020/08/02 20:18) documentation</title>



Expand Down Expand Up @@ -65,7 +65,7 @@

<div class="version">
z-2020-08-01-use-patches-only
(fdd7e9d
(e9c9199
)
</div>

Expand Down Expand Up @@ -112,6 +112,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="repositories.html">Contributed Binary Repositories</a></li>
<li class="toctree-l1"><a class="reference internal" href="f-a-q.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="about-and-thanks.html">About, Thanks and Funding</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/ocamlpro/opam-bin">Devel and Issues on Github</a></li>
</ul>
Expand Down
Loading

0 comments on commit b08e253

Please sign in to comment.