[PR PATCH] Manual.md: document vsrcextract, vsrccopy

[PR PATCH] Manual.md: document vsrcextract, vsrccopy

[classabbyamp]

[-- Attachment #1: Type: text/plain, Size: 412 bytes --]

There is a new pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages vsrc-doc
https://github.com/void-linux/void-packages/pull/48055

Manual.md: document vsrcextract, vsrccopy
@sgn, is this complete and accurate? should `vextract` also be documented?


A patch file from https://github.com/void-linux/void-packages/pull/48055.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-vsrc-doc-48055.patch --]
[-- Type: text/x-diff, Size: 1434 bytes --]

From 0d32bbe56e2110e16c655a9c127be4934a2d769c Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Wed, 3 Jan 2024 15:39:01 -0500
Subject: [PATCH] Manual.md: document vsrcextract, vsrccopy

---
 Manual.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/Manual.md b/Manual.md
index e6a98551eee30..12797485d7a52 100644
--- a/Manual.md
+++ b/Manual.md
@@ -335,6 +335,22 @@ The following functions are defined by `xbps-src` and can be used on any templat
 	it will default to `pkgname`. The `shell` argument can be one of `bash`,
 	`fish` or `zsh`.
 
+- *vsrcextract()* `[-C <target directory>] [--no-strip-components|--strip-components=<n>] <file>`
+
+	Extracts `$XBPS_SRCDISTDIR/$pkgname-$version/<file>` to `target directory`
+	with `n` directory components stripped. If `target directory` not specified,
+	defaults to the working directory. If `--strip-components` or `--no-strip-components`
+	is not specified, defaults to `--strip-components=1`.
+
+	This is useful when used in conjunction with `skip_extraction` and for submodule distfiles.
+
+- *vsrccopy()* `<file>... <target>`
+
+	Copies `file`s from `$XBPS_SRCDISTDIR/$pkgname-$version/` into the `target` directory,
+	creating `target` if it does not exist.
+
+	This is useful when used in conjunction with `skip_extraction`.
+
 > Shell wildcards must be properly quoted, Example: `vmove "usr/lib/*.a"`.
 
 <a id="global_vars"></a>

Re: Manual.md: document vsrcextract, vsrccopy

[sgn]

[-- Attachment #1: Type: text/plain, Size: 255 bytes --]

New comment by sgn on void-packages repository

https://github.com/void-linux/void-packages/pull/48055#issuecomment-1876191828

Comment:
The `vextract` was meant to abstract away the usage of `tar`, `bsdtar`, etc... in template. I think it's rarely used.

Re: Manual.md: document vsrcextract, vsrccopy

[classabbyamp]

[-- Attachment #1: Type: text/plain, Size: 166 bytes --]

New comment by classabbyamp on void-packages repository

https://github.com/void-linux/void-packages/pull/48055#issuecomment-1876201635

Comment:
ok I'll add it then

Re: [PR PATCH] [Updated] Manual.md: document vsrcextract, vsrccopy

[classabbyamp]

[-- Attachment #1: Type: text/plain, Size: 417 bytes --]

There is an updated pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages vsrc-doc
https://github.com/void-linux/void-packages/pull/48055

Manual.md: document vsrcextract, vsrccopy
@sgn, is this complete and accurate? should `vextract` also be documented?


A patch file from https://github.com/void-linux/void-packages/pull/48055.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-vsrc-doc-48055.patch --]
[-- Type: text/x-diff, Size: 1814 bytes --]

From 6c5138ba7e65358441641a2922bf843ea1127699 Mon Sep 17 00:00:00 2001
From: classabbyamp <void@placeviolette.net>
Date: Wed, 3 Jan 2024 15:39:01 -0500
Subject: [PATCH] Manual.md: document vextract, vsrcextract, vsrccopy

---
 Manual.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/Manual.md b/Manual.md
index e6a98551eee30..969d2ccc01e8f 100644
--- a/Manual.md
+++ b/Manual.md
@@ -335,6 +335,29 @@ The following functions are defined by `xbps-src` and can be used on any templat
 	it will default to `pkgname`. The `shell` argument can be one of `bash`,
 	`fish` or `zsh`.
 
+- *vextract()* `[-C <target directory>] [--no-strip-components|--strip-components=<n>] <file>`
+
+	Extracts `file` to `target directory` with `n` directory components stripped. If
+	`target directory` not specified, defaults to the working directory. If
+	`--strip-components` or `--no-strip-components` is not specified, defaults to
+	`--strip-components=1`.
+
+- *vsrcextract()* `[-C <target directory>] [--no-strip-components|--strip-components=<n>] <file>`
+
+	Extracts `$XBPS_SRCDISTDIR/$pkgname-$version/<file>` to `target directory`
+	with `n` directory components stripped. If `target directory` not specified,
+	defaults to the working directory. If `--strip-components` or `--no-strip-components`
+	is not specified, defaults to `--strip-components=1`.
+
+	This is useful when used in conjunction with `skip_extraction` and for submodule distfiles.
+
+- *vsrccopy()* `<file>... <target>`
+
+	Copies `file`s from `$XBPS_SRCDISTDIR/$pkgname-$version/` into the `target` directory,
+	creating `target` if it does not exist.
+
+	This is useful when used in conjunction with `skip_extraction`.
+
 > Shell wildcards must be properly quoted, Example: `vmove "usr/lib/*.a"`.
 
 <a id="global_vars"></a>

Re: [PR PATCH] [Merged]: Manual.md: document vextract, vsrcextract, vsrccopy

[classabbyamp]

[-- Attachment #1: Type: text/plain, Size: 272 bytes --]

There's a merged pull request on the void-packages repository

Manual.md: document vextract, vsrcextract, vsrccopy
https://github.com/void-linux/void-packages/pull/48055

Description:
@sgn, is this complete and accurate? ~~should `vextract` also be documented?~~ (added)