Bug 273359 - FreeBSD Handbook: Git is not an alternative to Git
Summary: FreeBSD Handbook: Git is not an alternative to Git
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-doc (Nobody)
URL: https://docs.freebsd.org/en/books/han...
Keywords:
Depends on:
Blocks:
 
Reported: 2023-08-26 10:26 UTC by Graham Perrin
Modified: 2024-05-30 15:32 UTC (History)
2 users (show)

See Also:


Attachments
signed-off .patch (1.91 KB, patch)
2023-08-26 10:26 UTC, Graham Perrin
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin 2023-08-26 10:26:15 UTC
Created attachment 244356 [details]
signed-off .patch

The note box: 

> Git is generally a developer tool. Users may prefer to use … git …

Looking ahead, after bug 255323 is fixed: 

- gitup might be shown here as a preferred (and Handbook-documented)
  alternative to Git. 

For now (the patch): 

- reword the sentence, to not imply that Git is an alternative to Git.
Comment 1 commit-hook freebsd_committer freebsd_triage 2024-05-30 15:31:32 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=ab127c4ff5d21816ebd58f8d6677d82ee6a5815e

commit ab127c4ff5d21816ebd58f8d6677d82ee6a5815e
Author:     Benedict Reuschling <bcr@FreeBSD.org>
AuthorDate: 2024-05-30 15:23:42 +0000
Commit:     Benedict Reuschling <bcr@FreeBSD.org>
CommitDate: 2024-05-30 15:23:42 +0000

    Do not recommend git as an alternative to git

    The link description would tell people to use git instead of git for
    updating ports. Remove that cross reference as suggested in the PR. Note
    that freebsd-update is eventually going away as well, but keep it here
    for now and remove it in a separate change in the future.

    Refrain from mentioning other third party tools in this section for keeping
    consistency with the rest of the handbook.

    PR:                 273359
    Based on patch by:  grahamperrin@gmail.com

 documentation/content/en/books/handbook/mirrors/_index.adoc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Comment 2 Benedict Reuschling freebsd_committer freebsd_triage 2024-05-30 15:32:10 UTC
A modified version of the patch was committed after bug #255323 is resolved. PR closed.