Github messages for voidlinux
 help / color / mirror / Atom feed
* [PR PATCH] Manual.md: designate place for Void-specific documentation
@ 2020-04-07 20:23 Chocimier
  2020-04-12  8:54 ` ericonr
                   ` (6 more replies)
  0 siblings, 7 replies; 8+ messages in thread
From: Chocimier @ 2020-04-07 20:23 UTC (permalink / raw)
  To: ml

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

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

https://github.com/Chocimier/void-packages-org readme.voidlinux
https://github.com/void-linux/void-packages/pull/20735

Manual.md: designate place for Void-specific documentation
This is meant to be used instead of install.msg for not critical information, and maybe some information from wiki.

I will clean up install.msgs if this is accepted.

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

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-readme.voidlinux-20735.patch --]
[-- Type: text/x-diff, Size: 1362 bytes --]

From dcd23b8ca06b42d9db8afc24b07055d97a91dcde Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20W=C3=B3jcik?= <chocimier@tlen.pl>
Date: Tue, 7 Apr 2020 22:21:28 +0200
Subject: [PATCH] Manual.md: designate place for Void-specific documentation

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

diff --git a/Manual.md b/Manual.md
index 92b57b1b2c2..53e8fae2bf8 100644
--- a/Manual.md
+++ b/Manual.md
@@ -67,6 +67,7 @@ packages for XBPS, the `Void Linux` native packaging system.
 		* [update-desktopdb](#triggers_update_desktopdb)
 		* [x11-fonts](#triggers_x11_fonts)
 		* [xml-catalog](#triggers_xml_catalog)
+	* [Void specific documentation](#documentation)
 	* [Notes](#notes)
 	* [Contributing via git](#contributing)
 * [Help](#help)
@@ -1936,6 +1937,14 @@ During removal it uses `xmlcatmgr` to remove all catalogs passed to it by the
 To include this trigger use the `sgml_entries` variable or/and the `xml_entries` variable,
 as the trigger won't do anything unless either of them are defined.
 
+<a id="documentation"></a>
+### Void specific documentation
+
+When you want document details of package's configuration and usage specific to Void Linux,
+not covered by upstream documentation, put notes into
+`srcpkgs/<pkgname>/files/README.voidlinux` and install with
+`vdoc "${FILESDIR}/README.voidlinux"`.
+
 <a id="notes"></a>
 ### Notes
 

^ permalink raw reply	[flat|nested] 8+ messages in thread
end of thread, other threads:[~2020-12-30  7:25 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-07 20:23 [PR PATCH] Manual.md: designate place for Void-specific documentation Chocimier
2020-04-12  8:54 ` ericonr
2020-04-20  4:22 ` CameronNemo
2020-04-20  4:23 ` CameronNemo
2020-04-20  5:01 ` CameronNemo
2020-04-20  5:09 ` CameronNemo
2020-04-20 17:59 ` Chocimier
2020-12-30  7:25 ` [PR PATCH] [Merged]: " the-maldridge

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).