From 26ab531a0abac615aaedf17622ee2aa5e19c5114 Mon Sep 17 00:00:00 2001
From: Marcel Telka <marcel@telka.sk>
Date: Fri, 05 Apr 2024 12:30:27 +0200
Subject: [PATCH] python/pipdeptree: update to 2.17.0

---
 README |   62 ++++++++++++++++++++++++++----
 1 files changed, 53 insertions(+), 9 deletions(-)

diff --git a/README b/README
index 06fe31e..183ae4e 100644
--- a/README
+++ b/README
@@ -51,24 +51,68 @@
     directory and use 'gmake download' from that to only get it's source
     archive.
 
+    Also, when you start to work with a new archive file - update the source
+    version in an existing recipe component, or start a new one from scratch -
+    you can use 'gmake fetch' to download the archive(s) defined in the new
+    recipe, calculate the checksums and *NOT* remove the archive because its
+    actual checksum does not match the value recorded in the recipe Makefile
+    (if any) so the download is deemed corrupted while you know it is not.
+    There is also a side-effect: by framework recipe, a file in the download
+    location only depends on the component recipe Makefile. So once an archive
+    is "fetched" (downloaded and not removed), it will not be re-verified -
+    the downloading script is just not called. This is a moderate problem,
+    since the "fetch" ability is a helper for recipe-makers doing initial
+    archive downloads in a certain situation, to save some traffic and time
+    on their workstations. You can still remove files fetched by a recipe
+    using 'gmake clobber'.
+
 Building the Bits
 
     You can build individual components or the contents of the entire gate.
 
+  Integration with ccache to speed up re-builds
+
+    If you happen to build the same sources several times (e.g. iterating
+    attempts to produce a working recipe, or maintaining an automated build
+    server), you can benefit from 'ccache' integration in 'oi-userland'.
+    Note that this feature is currently experimental and off by default.
+
+    The 'ccache' component is available as part of the project repository.
+    Once you have the resulting package installed, you can pass the 'make'
+    argument or environment variable 'ENABLE_CCACHE=true' to wrap the GNU
+    compiler invocations with the caching program - so that the same inputs
+    would re-produce same outputs quickly.
+
+    You can pre-set this variable in your user account '~/.profile' like this:
+
+       ### To speed up OI-userland re-builds
+       ENABLE_CCACHE=true
+       export ENABLE_CCACHE
+
+    Note: be wary of ccache's own CCACHE_DISABLE environment variable: any
+    value (empty, "false" etc.) is considered a "true" setting for ccache
+    booleans (and so disables the program, falling through to real compiler).
+
   Keeping all sources in one place
 
     The Userland consolidation tools automate download of required source
-    tarballs.  By default they are kept in each component's directory, but
-    you can centralize it by using the `USERLAND_ARCHIVES` variable.
+    tarballs.  By older default they were kept in each component's directory,
+    but you could centralize it by using the 'USERLAND_ARCHIVES' variable.
+    Recently the defaults change to pre-initialize 'USERLAND_ARCHIVES' to
+    point into '$(WS_TOP)/archives/' unless customized by the caller - for
+    example, to share the common download area between multiple workspaces.
 
-    You can pre-set this variable in your user account `~/.profile` like
+    You can pre-set this variable in your user account '~/.profile' like
     this (and note that the trailing slash is required):
 
-````
-# For oi-userland
-USERLAND_ARCHIVES="$HOME/Downloads/"
-export USERLAND_ARCHIVES
-````
+       ### For oi-userland source files
+       USERLAND_ARCHIVES="$HOME/Downloads/"
+       export USERLAND_ARCHIVES
+
+    See also the 'make-rules/shared-macros.mk' for 'INTERNAL_ARCHIVE_MIRROR',
+    'EXTERNAL_ARCHIVE_MIRROR' and envvar 'DOWNLOAD_SEARCH_PATH' to get some
+    ideas about using HTTP mirrors to e.g. reduce network load and lags if you
+    can access a country- or organization-local mirror of opensource projects.
 
   Component build
 
@@ -108,7 +152,7 @@
     succeed to complete the missing build products.
 
     It is worth noting that the OpenIndiana Hipster build server uses the
-    `COMPONENT_BUILD_ARGS=-j4` option by default for moderate parallelization
+    'COMPONENT_BUILD_ARGS=-j4' option by default for moderate parallelization
     of its builds.
 
     The gate should only incrementally build what it needs to based on what has

--
Gitblit v1.9.3