Merge pull request #3397 from rrigdon/update-link-scripts

[skip ci] Reorganized Resources, updated link scripts
conda · Feb 15, 2019 · b6c1dc3 · b6c1dc3
2 parents 87566f4 + e4cb7f2
commit b6c1dc3
Show file tree

Hide file tree

Showing 32 changed files with 67 additions and 33 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -23,22 +23,11 @@ Anaconda Cloud, you will need an
    source/install-conda-build
    source/concepts/index
    source/user-guide/index
-   source/package-spec
+   source/resources/index
    source/package-naming-conv
-   source/recipe
-   source/channels
-   source/define-metadata
-   source/build-scripts
    source/features
    source/environment-variables
-   source/make-relocatable
    source/debugging
-   source/link-scripts
-   source/variants
-   source/use-shared-libraries
-   source/compiler-tools
-   source/add-win-start-menu-items
    source/sample-recipes
    source/build-without-recipe
-   source/wheel-files
-   source/commands/index
+   source/wheel-files
diff --git a/docs/source/channels.rst → docs/source/concepts/channels.rst b/docs/source/channels.rst → docs/source/concepts/channels.rst
diff --git a/docs/source/concepts/index.rst b/docs/source/concepts/index.rst
@@ -1,12 +1,14 @@
-*********
+********
 Concepts
-*********
+********
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
 
    package-anatomy
    generating-index
+   channels
+   recipe
 
 What is a “package”?
 --------------------

diff --git a/docs/source/recipe.rst → docs/source/concepts/recipe.rst b/docs/source/recipe.rst → docs/source/concepts/recipe.rst
diff --git a/docs/source/build-scripts.rst → docs/source/resources/build-scripts.rst b/docs/source/build-scripts.rst → docs/source/resources/build-scripts.rst
diff --git a/docs/source/commands/conda-build.rst → ...source/resources/commands/conda-build.rst b/docs/source/commands/conda-build.rst → ...source/resources/commands/conda-build.rst
diff --git a/docs/source/commands/conda-convert.rst → ...urce/resources/commands/conda-convert.rst b/docs/source/commands/conda-convert.rst → ...urce/resources/commands/conda-convert.rst
diff --git a/docs/source/commands/conda-develop.rst → ...urce/resources/commands/conda-develop.rst b/docs/source/commands/conda-develop.rst → ...urce/resources/commands/conda-develop.rst
diff --git a/docs/source/commands/conda-index.rst → ...source/resources/commands/conda-index.rst b/docs/source/commands/conda-index.rst → ...source/resources/commands/conda-index.rst
diff --git a/...ource/commands/conda-inspect-channels.rst → ...urces/commands/conda-inspect-channels.rst b/...ource/commands/conda-inspect-channels.rst → ...urces/commands/conda-inspect-channels.rst
diff --git a/...ource/commands/conda-inspect-linkages.rst → ...urces/commands/conda-inspect-linkages.rst b/...ource/commands/conda-inspect-linkages.rst → ...urces/commands/conda-inspect-linkages.rst
diff --git a/...source/commands/conda-inspect-objects.rst → ...ources/commands/conda-inspect-objects.rst b/...source/commands/conda-inspect-objects.rst → ...ources/commands/conda-inspect-objects.rst
diff --git a/docs/source/commands/conda-inspect.rst → ...urce/resources/commands/conda-inspect.rst b/docs/source/commands/conda-inspect.rst → ...urce/resources/commands/conda-inspect.rst
diff --git a/docs/source/commands/conda-metapackage.rst → .../resources/commands/conda-metapackage.rst b/docs/source/commands/conda-metapackage.rst → .../resources/commands/conda-metapackage.rst
diff --git a/docs/source/commands/conda-render.rst → ...ource/resources/commands/conda-render.rst b/docs/source/commands/conda-render.rst → ...ource/resources/commands/conda-render.rst
diff --git a/docs/source/commands/conda-skeleton-cpan.rst → ...esources/commands/conda-skeleton-cpan.rst b/docs/source/commands/conda-skeleton-cpan.rst → ...esources/commands/conda-skeleton-cpan.rst
diff --git a/docs/source/commands/conda-skeleton-cran.rst → ...esources/commands/conda-skeleton-cran.rst b/docs/source/commands/conda-skeleton-cran.rst → ...esources/commands/conda-skeleton-cran.rst
diff --git a/...urce/commands/conda-skeleton-luarocks.rst → ...rces/commands/conda-skeleton-luarocks.rst b/...urce/commands/conda-skeleton-luarocks.rst → ...rces/commands/conda-skeleton-luarocks.rst
diff --git a/docs/source/commands/conda-skeleton-pypi.rst → ...esources/commands/conda-skeleton-pypi.rst b/docs/source/commands/conda-skeleton-pypi.rst → ...esources/commands/conda-skeleton-pypi.rst
diff --git a/docs/source/commands/conda-skeleton.rst → ...rce/resources/commands/conda-skeleton.rst b/docs/source/commands/conda-skeleton.rst → ...rce/resources/commands/conda-skeleton.rst
diff --git a/docs/source/commands/index.rst → docs/source/resources/commands/index.rst b/docs/source/commands/index.rst → docs/source/resources/commands/index.rst
diff --git a/docs/source/compiler-tools.rst → docs/source/resources/compiler-tools.rst b/docs/source/compiler-tools.rst → docs/source/resources/compiler-tools.rst
diff --git a/docs/source/define-metadata.rst → docs/source/resources/define-metadata.rst b/docs/source/define-metadata.rst → docs/source/resources/define-metadata.rst
diff --git a/docs/source/resources/index.rst b/docs/source/resources/index.rst
@@ -0,0 +1,17 @@
+*********
+Resources
+*********
+
+.. toctree::
+   :maxdepth: 1
+
+   build-scripts
+   compiler-tools
+   define-metadata
+   link-scripts
+   make-relocatable
+   package-spec
+   use-shared-libraries
+   variants
+   commands/index
+
diff --git a/docs/source/link-scripts.rst → docs/source/resources/link-scripts.rst b/docs/source/link-scripts.rst → docs/source/resources/link-scripts.rst
@@ -4,19 +4,7 @@ Adding pre-link, post-link and pre-unlink scripts
 
 .. TODO: Add post-unlink
 
-You can add scripts to a recipe. These scripts are executed in a subprocess by
-conda, using ``/bin/bash <script>`` on Linux and macOS, and
-``%COMSPEC% /c <script>`` on Windows.
-
-The convention for the path and filenames of these scripts on Windows is::
-
-  Scripts/.<name>-<action>.bat
-
-On Linux and macOS, the convention is::
-
-  bin/.<name>-<action>.sh
-
-``<name>`` is the package name and ``<action>`` is one of the following:
+You can add scripts to a recipe. They must be located in the same directory as the meta.yaml file. The following scripts can be added:
 
 * ``pre-link``---Executed before the package is installed. An error is
   indicated by a nonzero exit and causes conda to stop and causes the
@@ -27,9 +15,20 @@ On Linux and macOS, the convention is::
 * ``pre-unlink``---Executed before the package is removed. An error is
   indicated by a nonzero exist and causes the removal to fail.
 
-EXAMPLE: When there is a script named ``/bin/.foo-post-link.sh`` in the package
-``foo-1.0-0.tar.bz2``, it is executed after the package is installed.
+In addition to being co-located with the meta.yaml file, they must be named simply ``post-link.sh`` or ``post-link.bat``. Conda-build will rename them to .<name>-<action>.sh (or .bat) where ``<name>`` is the package name and ``<action>`` is one of the preceeding actions.
 
+These scripts are executed in a subprocess by
+conda, using ``/bin/bash <script>`` on Linux and macOS and
+``%COMSPEC% /c <script>`` on Windows.
+
+The convention for the path and filenames of these scripts on Windows is::
+
+  Scripts/.<name>-<action>.bat
+
+On Linux and macOS the convention is::
+
+  bin/.<name>-<action>.sh
+  
 The scripts set the following environment variables:
 
 .. list-table::
@@ -63,7 +62,7 @@ Post-link and pre-unlink scripts should:
 * Be avoided whenever possible.
 * Not touch anything other than the files being installed.
 * Not write anything to stdout or stderr, unless an error occurs.
-* Not depend on any installed or to be installed conda packages.
+* Not depend on any installed or to-be-installed conda packages.
 * Depend only on simple system tools such as ``rm``, ``cp``, ``mv`` and ``ln``.
 
 The scripts should not write to stdout or stderr unless an error occurs, but

diff --git a/docs/source/make-relocatable.rst → docs/source/resources/make-relocatable.rst b/docs/source/make-relocatable.rst → docs/source/resources/make-relocatable.rst
diff --git a/docs/source/package-spec.rst → docs/source/resources/package-spec.rst b/docs/source/package-spec.rst → docs/source/resources/package-spec.rst
diff --git a/docs/source/use-shared-libraries.rst → ...source/resources/use-shared-libraries.rst b/docs/source/use-shared-libraries.rst → ...source/resources/use-shared-libraries.rst
diff --git a/docs/source/variants.rst → docs/source/resources/variants.rst b/docs/source/variants.rst → docs/source/resources/variants.rst
diff --git a/docs/source/add-win-start-menu-items.rst → ...de/tutorials/add-win-start-menu-items.rst b/docs/source/add-win-start-menu-items.rst → ...de/tutorials/add-win-start-menu-items.rst
diff --git a/docs/source/user-guide/tutorials/index.rst b/docs/source/user-guide/tutorials/index.rst
@@ -3,5 +3,7 @@ Tutorials
 *********
 
 .. toctree::
+   :maxdepth: 1
 
-  build-windows
+  build-windows
+  add-win-start-menu-items
diff --git a/news/update-link-scripts b/news/update-link-scripts
@@ -0,0 +1,25 @@
+Enhancements:
+-------------
+
+* <news item>
+
+Bug fixes:
+----------
+
+* <news item>
+
+Deprecations:
+-------------
+
+* <news item>
+
+Docs:
+-----
+
+* Reorganized conda-build topics, updated link-scripts
+
+Other:
+------
+
+* <news item>
+