Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 829916 - Add tables of pattern metacharacters and constructs to bash/text.xml
Summary: Add tables of pattern metacharacters and constructs to bash/text.xml
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-12-24 09:03 UTC by Alexis
Modified: 2022-06-10 17:15 UTC (History)
3 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
diff for tools-reference/bash/text.xml (bash.xml.diff,1.80 KB, patch)
2021-12-24 09:03 UTC, Alexis
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Alexis 2021-12-24 09:03:11 UTC
Created attachment 760179 [details, diff]
diff for tools-reference/bash/text.xml

The attached patch addresses two <todo>s in tools-reference/bash/text.xml.
Comment 1 Ulrich Müller gentoo-dev 2021-12-24 09:47:52 UTC
Thanks for the patch.

Could you git-format-patch it and include a Signed-off-by line, please? (See https://www.gentoo.org/glep/glep-0076.html#certificate-of-origin for the latter.)
Comment 2 Alexis 2021-12-24 11:17:32 UTC
Hmm .... From my reading of that GLEP, i'm required to provide my *full* legal name? Simply my first name won't suffice? If so, i'm afraid i'm not willing to do that, sorry. Otherwise, sure, i can do as you request.
Comment 3 Ulrich Müller gentoo-dev 2021-12-24 22:55:43 UTC
(In reply to Alexis from comment #2)
> Hmm .... From my reading of that GLEP, i'm required to provide my *full*
> legal name? Simply my first name won't suffice? If so, i'm afraid i'm not
> willing to do that, sorry. Otherwise, sure, i can do as you request.

Hm, looks like we're facing a different problem here. The second table is a verbatim copy from https://www.gnu.org/software/bash/manual/bash.html#Pattern-Matching, and the entries in the first table take some phrases from there as well.

The Bash manual is licensed under the FDL-1.3. So we cannot include material from there in the devmanual (under CC-BY-SA-4.0), unless the material is below the threshold of originality.

CCing licenses team, any opinion? Is this long enough to be copyrightable?
Comment 4 Alexis 2021-12-24 23:54:17 UTC
Ah, yes, sorry, i didn't even consider that issue. Since paraphrasing can result in unintentionally (not) implying certain behaviour(s) that don't match actual code behaviour(s), i indeed copied text verbatim. So i'm certainly interested in the licenses team's opinion on this, and whether it perhaps also applies to wiki content.

Regardless, i'd still like to know to what extent that GLEP and its requirements might limit my ability to contribute to Gentoo. Does it apply to me creating / modifying ebuilds, e.g. https://bugs.gentoo.org/824022 ? Does it apply to me requesting that an overlay such as https://github.com/flexibeast/gentoo-s6-overlay be included in the list of available overlays? (And actually, am i running afoul of copyright issues just by creating an overlay of mostly just updated ebuilds necessary to create other ebuilds?)
Comment 5 Alexis 2022-01-17 02:33:32 UTC
Ping.

More generally, is there a better place to direct the questions i asked in the "Regardless, i'd still like to know ..." paragraph in my previous comment? i'd love to continue working on my s6 and 66 overlays, but i'd like some clarification as to what is and isn't appropriate.
Comment 6 Sam James archtester Gentoo Infrastructure gentoo-dev Security 2022-01-17 02:37:50 UTC
(In reply to Alexis from comment #4)
> Regardless, i'd still like to know to what extent that GLEP and its
> requirements might limit my ability to contribute to Gentoo. Does it apply
> to me creating / modifying ebuilds, e.g. https://bugs.gentoo.org/824022 ?

This depends on whether the committer considers it trivial I suppose.

> Does it apply to me requesting that an overlay such as
> https://github.com/flexibeast/gentoo-s6-overlay be included in the list of
> available overlays? (And actually, am i running afoul of copyright issues
> just by creating an overlay of mostly just updated ebuilds necessary to
> create other ebuilds?)

No, this should be fine, and it's all GPLv2 anyway unless otherwise stated.
Comment 7 Ulrich Müller gentoo-dev 2022-01-17 10:38:08 UTC
I have asked Bash upstream (with CC to licensing@fsf.org) about the issue.
Comment 8 Alexis 2022-01-18 12:00:34 UTC
(In reply to Sam James from comment #6)

> No, this should be fine, and it's all GPLv2 anyway unless otherwise stated.
Thanks, i've now created an api-gentoo-org PR for my overlay. 

(In reply to Ulrich Müller from comment #7)

> I have asked Bash upstream (with CC to licensing@fsf.org) about the issue.
Okay, thanks.
Comment 9 Ulrich Müller gentoo-dev 2022-06-04 19:26:41 UTC
Unfornunately, still no answer from licensing@fsf.org after 4 months. Upstream has replied though (and gave permission to post this here):

From: Chet Ramey <chet.ramey@case.edu>
Subject: Re: Copyright/license question about the Bash manual
To: Ulrich Müller <ulm@gentoo.org>
Cc: chet.ramey@case.edu, licensing@fsf.org, devmanual@gentoo.org
Date: Mon, 17 Jan 2022 12:59:00 -0500 (19 weeks, 5 days, 1 hour ago)
Organization: ITS, Case Western Reserve University
Reply-To: chet.ramey@case.edu

On 1/17/22 5:37 AM, Ulrich Müller wrote:
> Hi,
> at Gentoo we have received a user-contributed patch for our
> Developer
> Manual. It turns out that it contains some material that was copied
> from the Bash manual:
>     Gentoo bug: https://bugs.gentoo.org/829916#c3
>     Patch: https://829916.bugs.gentoo.org/attachment.cgi?id=760179
>     Bash manual section: https://www.gnu.org/software/bash/manual/bash.html#Pattern-Matching

This text doesn't seem unique enough to matter, considering there are
several shell implementations that have the same capability documented
in very similar ways.

The basic pattern matching characters are common across every shell, and
appear to be documentd exactly the same way. The extended matching
constructs are available in essentially the same form in several shells.
The goal for the latter is to have enough similarity between separate
implementations and their documentation to be considered for
standardization.

(As an aside, I'd document what a `pattern-list' means as well.)

I'll leave the rest of the questions for the licensing folks.

Chet
-- 
``The lyf so short, the craft so long to lerne.'' - Chaucer
		 ``Ars longa, vita brevis'' - Hippocrates
Chet Ramey, UTech, CWRU    chet@case.edu    http://tiswww.cwru.edu/~chet/
Comment 10 Larry the Git Cow gentoo-dev 2022-06-10 17:15:51 UTC
The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=7d05c22848ed37bf5b594a30e56ee2793d1b1afb

commit 7d05c22848ed37bf5b594a30e56ee2793d1b1afb
Author:     Ulrich Müller <ulm@gentoo.org>
AuthorDate: 2022-06-04 21:24:47 +0000
Commit:     Ulrich Müller <ulm@gentoo.org>
CommitDate: 2022-06-10 17:14:07 +0000

    tools-reference/bash: Add tables of metacharacters and constructs
    
    Parts of this have been taken from the Bash Reference Manual authored by
    Chet Ramey and Brian Fox. See https://bugs.gentoo.org/829916#c9.
    
    Closes: https://bugs.gentoo.org/829916
    Reported-by: Alexis <flexibeast@gmail.com>
    Signed-off-by: Ulrich Müller <ulm@gentoo.org>

 tools-reference/bash/text.xml | 61 ++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 54 insertions(+), 7 deletions(-)