Github messages for voidlinux
 help / color / mirror / Atom feed
From: classabbyamp <classabbyamp@users.noreply.github.com>
To: ml@inbox.vuxu.org
Subject: Re: [PR PATCH] [Updated] Manual.md: document vsrcextract, vsrccopy
Date: Fri, 05 Jan 2024 08:32:51 +0100	[thread overview]
Message-ID: <20240105073251.785aG5kTuwMPx4qTt9m-_szvVD38H83QocUtChKnQrk@z> (raw)
In-Reply-To: <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-48055@inbox.vuxu.org>

[-- 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>

  parent reply	other threads:[~2024-01-05  7:32 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-03 20:40 [PR PATCH] " classabbyamp
2024-01-04  1:36 ` sgn
2024-01-04  1:50 ` classabbyamp
2024-01-05  7:32 ` classabbyamp [this message]
2024-02-02  8:08 ` [PR PATCH] [Merged]: Manual.md: document vextract, " classabbyamp

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240105073251.785aG5kTuwMPx4qTt9m-_szvVD38H83QocUtChKnQrk@z \
    --to=classabbyamp@users.noreply.github.com \
    --cc=ml@inbox.vuxu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).