[gentoo-catalyst] [PATCH] Documentation: Make existing multi-overlay support more explicit

[gentoo-catalyst] [PATCH] Documentation: Make existing multi-overlay support more explicit

[Felix Bier]

The code already supports multiple overlays. This commit adapts the
documentation to make this more explicit.
---
 doc/catalyst-spec.5.txt              | 5 +++--
 examples/generic_stage_template.spec | 5 +++--
 examples/livecd-stage1_template.spec | 5 +++--
 examples/livecd-stage2_template.spec | 5 +++--
 examples/netboot_template.spec       | 5 +++--
 examples/stage4_template.spec        | 5 +++--
 6 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/doc/catalyst-spec.5.txt b/doc/catalyst-spec.5.txt
index 43cd5d2f..beabd1b3 100644
--- a/doc/catalyst-spec.5.txt
+++ b/doc/catalyst-spec.5.txt
@@ -87,8 +87,9 @@ This is an optional directory containing portage
configuration files
 problems.
 
 *portage_overlay*::
-This option specifies the location to a portage overlay that you would
-like to use when building this target (example: `/usr/local/portage`).
+This option specifies the location of the portage overlays that you
would
+like to have used when building this target. It takes a space-
separated list
+of directory names. (example: `/usr/local/portage`).
 
 *pkgcache_path*::
 This allows the optional directory containing the output packages for
diff --git a/examples/generic_stage_template.spec
b/examples/generic_stage_template.spec
index 01c37789..f8cda40a 100644
--- a/examples/generic_stage_template.spec
+++ b/examples/generic_stage_template.spec
@@ -96,8 +96,9 @@ distcc_hosts:
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you
would like to
-# have used when building this target.
+# This option specifies the location of the portage overlays that you
would
+# like to have used when building this target. It takes a space-
separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/livecd-stage1_template.spec b/examples/livecd-
stage1_template.spec
index c7086c91..c37616c0 100644
--- a/examples/livecd-stage1_template.spec
+++ b/examples/livecd-stage1_template.spec
@@ -59,8 +59,9 @@ distcc_hosts:
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you
would like to
-# have used when building this target.
+# This option specifies the location of the portage overlays that you
would
+# like to have used when building this target. It takes a space-
separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/livecd-stage2_template.spec b/examples/livecd-
stage2_template.spec
index 56bda84a..dde1b27e 100644
--- a/examples/livecd-stage2_template.spec
+++ b/examples/livecd-stage2_template.spec
@@ -59,8 +59,9 @@ distcc_hosts:
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you
would like to
-# have used when building this target.
+# This option specifies the location of the portage overlays that you
would
+# like to have used when building this target. It takes a space-
separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/netboot_template.spec
b/examples/netboot_template.spec
index 4f76b8ff..196cbafb 100644
--- a/examples/netboot_template.spec
+++ b/examples/netboot_template.spec
@@ -6,8 +6,9 @@ profile: uclibc/mips
 snapshot: 20060107
 source_subpath: default/stage3-mips-uclibc-mips3-2006.126
 
-# This option specifies the location to a portage overlay that you
would like to
-# have used when building this target.
+# This option specifies the location of the portage overlays that you
would
+# like to have used when building this target. It takes a space-
separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/stage4_template.spec
b/examples/stage4_template.spec
index 562bfaac..87240c0a 100644
--- a/examples/stage4_template.spec
+++ b/examples/stage4_template.spec
@@ -59,8 +59,9 @@ distcc_hosts:
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you
would like to
-# have used when building this target.
+# This option specifies the location of the portage overlays that you
would
+# like to have used when building this target. It takes a space-
separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
-- 
2.28.0

[gentoo-catalyst] Re: [PATCH] Documentation: Make existing multi-overlay support more explicit

[Felix Bier]

The code already supports multiple overlays. This commit adapts the
documentation to make this more explicit.
---
 doc/catalyst-spec.5.txt              | 5 +++--
 examples/generic_stage_template.spec | 5 +++--
 examples/livecd-stage1_template.spec | 5 +++--
 examples/livecd-stage2_template.spec | 5 +++--
 examples/netboot_template.spec       | 5 +++--
 examples/stage4_template.spec        | 5 +++--
 6 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/doc/catalyst-spec.5.txt b/doc/catalyst-spec.5.txt
index 43cd5d2f..beabd1b3 100644
--- a/doc/catalyst-spec.5.txt
+++ b/doc/catalyst-spec.5.txt
@@ -87,8 +87,9 @@ This is an optional directory containing portage configuration files
 problems.
 
 *portage_overlay*::
-This option specifies the location to a portage overlay that you would
-like to use when building this target (example: `/usr/local/portage`).
+This option specifies the location of the portage overlays that you would
+like to have used when building this target. It takes a space-separated list
+of directory names. (example: `/usr/local/portage`).
 
 *pkgcache_path*::
 This allows the optional directory containing the output packages for
diff --git a/examples/generic_stage_template.spec b/examples/generic_stage_template.spec
index 01c37789..f8cda40a 100644
--- a/examples/generic_stage_template.spec
+++ b/examples/generic_stage_template.spec
@@ -96,8 +96,9 @@ distcc_hosts:
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you would like to
-# have used when building this target.
+# This option specifies the location of the portage overlays that you would
+# like to have used when building this target. It takes a space-separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/livecd-stage1_template.spec b/examples/livecd-stage1_template.spec
index c7086c91..c37616c0 100644
--- a/examples/livecd-stage1_template.spec
+++ b/examples/livecd-stage1_template.spec
@@ -59,8 +59,9 @@ distcc_hosts:
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you would like to
-# have used when building this target.
+# This option specifies the location of the portage overlays that you would
+# like to have used when building this target. It takes a space-separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/livecd-stage2_template.spec b/examples/livecd-stage2_template.spec
index 56bda84a..dde1b27e 100644
--- a/examples/livecd-stage2_template.spec
+++ b/examples/livecd-stage2_template.spec
@@ -59,8 +59,9 @@ distcc_hosts:
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you would like to
-# have used when building this target.
+# This option specifies the location of the portage overlays that you would
+# like to have used when building this target. It takes a space-separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/netboot_template.spec b/examples/netboot_template.spec
index 4f76b8ff..196cbafb 100644
--- a/examples/netboot_template.spec
+++ b/examples/netboot_template.spec
@@ -6,8 +6,9 @@ profile: uclibc/mips
 snapshot: 20060107
 source_subpath: default/stage3-mips-uclibc-mips3-2006.126
 
-# This option specifies the location to a portage overlay that you would like to
-# have used when building this target.
+# This option specifies the location of the portage overlays that you would
+# like to have used when building this target. It takes a space-separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/stage4_template.spec b/examples/stage4_template.spec
index 562bfaac..87240c0a 100644
--- a/examples/stage4_template.spec
+++ b/examples/stage4_template.spec
@@ -59,8 +59,9 @@ distcc_hosts:
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you would like to
-# have used when building this target.
+# This option specifies the location of the portage overlays that you would
+# like to have used when building this target. It takes a space-separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
-- 
2.28.0

Re: [gentoo-catalyst] Re: [PATCH] Documentation: Make existing multi-overlay support more explicit

[Matt Turner]

On Sun, Oct 18, 2020 at 11:07 AM Felix Bier
<Felix.Bier@rohde-schwarz.com> wrote:
>
> The code already supports multiple overlays. This commit adapts the
> documentation to make this more explicit.

Looks good, though I wonder if we shouldn't rename 'portage_overlay'
as well? 'repos' or something?

I'm going to change the custom .spec format over to TOML soon, so I
can do that then unless you want to handle it.

I'll commit this if you will give me your Signed-off-by for the patches. Thanks!

Re: [Newsletter] Re: [gentoo-catalyst] Re: [PATCH] Documentation: Make existing multi-overlay support more explicit

[Felix Bier]

Am Freitag, den 30.10.2020, 11:54 -0400 schrieb Matt Turner:
> Looks good, though I wonder if we shouldn't rename 'portage_overlay'
> as well? 'repos' or something?
> 
> I'm going to change the custom .spec format over to TOML soon, so I
> can do that then unless you want to handle it.

I agree that 'portage_overlay' should be renamed. It seems 'repos' is
already taken (for the portage snapshot feature). We could rename
'repos' -> 'repos_storedir' and then 'portage_overlay' -> 'repos', but
I would prefer to keep this step separate from the PORTDIR_OVERLAY
removal.

My plan for the next steps would be:

 * Remove PORTDIR as well
 * Remove copying of overlays in favor of mounting
 * Somehow merge 'snapshot_treeish' and 'portage_overlay' into a single
option (called e.g. 'repos'), which takes a list of repo snapshots. So
there would no longer be a special main repo.

> 
> I'll commit this if you will give me your Signed-off-by for the
> patches. Thanks!

Re: [Newsletter] Re: [gentoo-catalyst] Re: [PATCH] Documentation: Make existing multi-overlay support more explicit

[Felix Bier]

The code already supports multiple repositories. This commit adapts the
documentation to make this more explicit.

Signed-off-by: Felix Bier <felix.bier@rohde-schwarz.com>
---
 doc/catalyst-spec.5.txt              | 5 +++--
 examples/generic_stage_template.spec | 5 +++--
 examples/livecd-stage1_template.spec | 5 +++--
 examples/livecd-stage2_template.spec | 5 +++--
 examples/netboot_template.spec       | 5 +++--
 examples/stage4_template.spec        | 5 +++--
 6 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/doc/catalyst-spec.5.txt b/doc/catalyst-spec.5.txt
index 31e69820..4c1df857 100644
--- a/doc/catalyst-spec.5.txt
+++ b/doc/catalyst-spec.5.txt
@@ -81,8 +81,9 @@ This is an optional directory containing portage configuration files
 problems.
 
 *portage_overlay*::
-This option specifies the location to a portage overlay that you would
-like to use when building this target (example: `/usr/local/portage`).
+This option specifies the location of the ebuild repositories that you would
+like to have used when building this target. It takes a space-separated list
+of directory names. (example: `/usr/local/portage`).
 
 *pkgcache_path*::
 This allows the optional directory containing the output packages for
diff --git a/examples/generic_stage_template.spec b/examples/generic_stage_template.spec
index 8f0375c4..8c8889bf 100644
--- a/examples/generic_stage_template.spec
+++ b/examples/generic_stage_template.spec
@@ -89,8 +89,9 @@ decompressor_search_order: lbzip2 bzip2 tar pixz xz gzip squashfs
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you would like to
-# have used when building this target.
+# This option specifies the location of the ebuild repositories that you would
+# like to have used when building this target. It takes a space-separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/livecd-stage1_template.spec b/examples/livecd-stage1_template.spec
index b921372a..269a1e3d 100644
--- a/examples/livecd-stage1_template.spec
+++ b/examples/livecd-stage1_template.spec
@@ -52,8 +52,9 @@ source_subpath:
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you would like to
-# have used when building this target.
+# This option specifies the location of the ebuild repositories that you would
+# like to have used when building this target. It takes a space-separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/livecd-stage2_template.spec b/examples/livecd-stage2_template.spec
index ac1cd3e4..4f50919f 100644
--- a/examples/livecd-stage2_template.spec
+++ b/examples/livecd-stage2_template.spec
@@ -52,8 +52,9 @@ source_subpath:
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you would like to
-# have used when building this target.
+# This option specifies the location of the ebuild repositories that you would
+# like to have used when building this target. It takes a space-separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/netboot_template.spec b/examples/netboot_template.spec
index 4f76b8ff..ad9d993c 100644
--- a/examples/netboot_template.spec
+++ b/examples/netboot_template.spec
@@ -6,8 +6,9 @@ profile: uclibc/mips
 snapshot: 20060107
 source_subpath: default/stage3-mips-uclibc-mips3-2006.126
 
-# This option specifies the location to a portage overlay that you would like to
-# have used when building this target.
+# This option specifies the location of the ebuild repositories that you would
+# like to have used when building this target. It takes a space-separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
diff --git a/examples/stage4_template.spec b/examples/stage4_template.spec
index c901eabc..aea70e86 100644
--- a/examples/stage4_template.spec
+++ b/examples/stage4_template.spec
@@ -52,8 +52,9 @@ source_subpath:
 # portage_confdir: /etc/portage
 portage_confdir:
 
-# This option specifies the location to a portage overlay that you would like to
-# have used when building this target.
+# This option specifies the location of the ebuild repositories that you would
+# like to have used when building this target. It takes a space-separated list
+# of directory names.
 # example:
 # portage_overlay: /usr/local/portage
 portage_overlay:
-- 
2.29.2