Git and related corrections and improvements #182
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make proper use of words such as these. In Git, HEAD is not a branch; and so on.
Fix line 1049 of my 3aa3aa2. Avoid ambiguous phrases such as mainline and main line. Be consistent with markup, wherever main is a branch.
Under <https://docs.freebsd.org/en/articles/committers-guide/#_rebasing_your_change_against_latest_freebsd_source_tree>, a list of items is misrepresented as a single paragraph with asterisk characters in its midst. Fix the markup.
Under <https://docs.freebsd.org/en/articles/committers-guide/#pref-license>: * "… approval of the core@FreeBSD.org to …" is bad grammar. Remove the word 'the' * "the main repository" is ambiguous; there are three repositories.
More consistency with markup. Where quarterly ports branches are described, use latest (not current) to describe latest.
Monospace for commands, namespaces, and so on.
grahamperrin
commented
May 7, 2023
With Git, for the ports repo: HEAD is not a branch; latest is not a branch; quarterly is not a branch; and so on.
-CURRENT is not a branch.
CURRENT is not a branch.
bsdimp
reviewed
May 7, 2023
grahamperrin
commented
May 7, 2023
grahamperrin
commented
May 7, 2023
This comment was marked as resolved.
This comment was marked as resolved.
grahamperrin
commented
May 7, 2023
Remove 'Migrating from an existing Git clone'. Resolve <freebsd#182 (review)>.
As we removed preceding sentence, about master and main, so we can remove this sentence about both branch names.
<https://docs.freebsd.org/en/articles/committers-guide/#_branch_names> was a single-paragraph subsection from around the time of migration to Git. It mentioned master; did not mention releng branches; and so on. Rewrite the subsection, provide examples (including tags). Keep it brief. Phrases such as FREEBSD-CURRENT and FREEBSD-STABLE are fine at <https://www.freebsd.org/releases/#future>, should be equally fine in this Guide.
This comment was marked as outdated.
This comment was marked as outdated.
Resolve <https://reviews.freebsd.org/D40026#inline-244491>. Reword what's nearby. For the optional directory: instead of dir, use what's at <https://git-scm.com/docs/git-clone#Documentation/git-clone.txt-ltdirectorygt>: <directory>
freebsd-git
pushed a commit
that referenced
this pull request
May 16, 2023
df53ae0fdd98e9452095ac2fdaf95fcfac8c9c7f (2023-04-23): * removed portsnap * encourages use of Git. This round of Git-oriented corrections and changes is, essentially, timed to precede creation of the releng/14.0 branch. Not intended to be comprehensive. Attention to things such as: * HEAD (not a branch) and main (branch) * main (not a branch) and mainline * repositories (there are three) * ports latest, current (not CURRENT) and quarterly * FREEBSD-CURRENT and FREEBSD-STABLE * master * things that were relevant only around the time of migration to Git * markup * grammar. Under https://docs.freebsd.org/en/articles/committers-guide/#_rebasing_your_change_against_latest_freebsd_source_tree a list of items was misrepresented as a single paragraph with asterisk characters in its midst. Reviewed by: carlavilla, imp Approved by: imp Pull Request: #182 Differential revision: https://reviews.freebsd.org/D40026
|
The pre-closure comment in Phabricator:
Since the list at https://docs.freebsd.org/en/articles/committers-guide/#_rebasing_your_change_against_latest_freebsd_source_tree has been fixed (to appear as a list), it's easier to see that some occurrences of XXX are not monospace:
And so on … |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
freebsd/freebsd-src@df53ae0:
Aim to correct Git-related mistakes as soon as possible before creation of the releng/14.0 branch.