spdx / spdx/LicenseListPublisher

Superfluous spaces in `match` of some GFDL-1.x-* standard header templates

Open
#233 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
23
Forks
29
Avg merge
6h 31m
Merged PRs (30d)
2

Description

The following GFDL license standard header templates contain a var/match with rather superfluous spaces in the regex:

  • GFDL-1.1-invariants-only
  • GFDL-1.1-invariants-or-later
  • GFDL-1.1-only
  • GFDL-1.1-or-later
  • GFDL-1.2-invariants-only
  • GFDL-1.2-invariants-or-later
  • GFDL-1.2-only
  • GFDL-1.2-or-later
  • GFDL-1.3-invariants-only
  • GFDL-1.3-invariants-or-later
  • GFDL-1.3-only
  • GFDL-1.3-or-later
    The other GFDL license details (e.g. GFDL-1.3) are fine.

For example, the GFDL-1.3-only standard header template (line wraps for posterity by me) looks like this:

Copyright (c) 
<<var;name=\"copyright\";original=\"YEAR YOUR NAME\";match=\".+\">> 
 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3; with
<<var;name=\"invariantSections\";original=\"the Invariant Sections being LIST THEIR TITLES\";match=\"the Invariant Sections       being .+|no Invariant Sections\">> 
 , with
<<var;name=\"frontCoverTexts\";original=\"the Front-Cover Texts being LIST\";match=\"the Front-Cover Texts being .+|no Front-Cover Texts\">> 
 , and with
<<var;name=\"backCoverTexts\";original=\"the Back-Cover Texts being LIST\";match=\"the Back-Cover Texts being .+|no Back-Cover Texts\">> 
 . A copy of the license is included in the section entitled \"GNU Free Documentation License\".

The 2nd var has the match with the pattern the Invariant Sections being .+|no Invariant Sections (notice the many spaces), which doesn't match the corresponding part of standard header template text ("the Invariant Sections being LIST THEIR TITLES"), which has only one space.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the license standard-header templates for the twelve listed GFDL-1.x-* names and the the Invariant Sections being pattern. Compare each var/match expression with its corresponding header text, then verify that all twelve affected templates use matching spacing and that the other GFDL details remain unchanged.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.