Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

git-ls-tree, git-rev-list, git-rev-parse: add pages #3644

Merged
merged 11 commits into from
Dec 17, 2019

Conversation

BeLi4L
Copy link
Contributor

@BeLi4L BeLi4L commented Dec 5, 2019

  • The page (if new), does not already exist in the repo.
  • The page is in the correct platform directory (common/, linux/, etc.)
  • The page has 8 or fewer examples.
  • The PR title conforms to the recommended templates.
  • The page follows the content guidelines.
  • The page description includes a link to documentation or a homepage (if applicable).

@BeLi4L BeLi4L changed the title Patch 1 Add pages for git-ls-tree, git-rev-list, git-rev-parse Dec 5, 2019
@BeLi4L BeLi4L changed the title Add pages for git-ls-tree, git-rev-list, git-rev-parse git-ls-tree, git-rev-list, git-rev-parse: add pages Dec 5, 2019

- List the contents of the tree on a commit and show only filenames:

`git ls-tree --name-only {{HEAD~3}}`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would change HEAD~3 to HEAD~N and note it shows the situation N commits ago or something like that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

a2c3e61

Copy link
Contributor

@zlatanvasovic zlatanvasovic Dec 5, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather not put it as {{{HEAD}}~{{N}}. Maybe just HEAD~{{N}}?

/cc @waldyrious what would be the proper syntax here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BeLi4L maybe wait for a consensus to emerge in these discussions before applying the changes, otherwise you may need to do a lot of back and forth 😅

As for the syntax, I'm afraid we're making things too complex. The syntax for relative references is not something that this page is responsible for introducing. My suggestion is to simply include the 3 in the command description, and use {{HEAD~3}} as the token, rather than generalize with N. WDYT?

Copy link
Member

@waldyrious waldyrious Dec 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe we could bypass this conundrum altogether by using another type of reference, like a tag (e.g. {{v1.2.3}}).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zdroid I'd like to know what you dislike about using a tag, in light of my comments above.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't the term commit-ish used in the man pages?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any news on this? I can use commit-ish if you're all OK with that

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current version is fine with me. Maybe @sbrl wants to use "commit-ish" instead, both work for me.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind. Either work for me.

@tldr-bot
Copy link

tldr-bot commented Dec 5, 2019

The build
for this PR failed with the following error(s):

pages.pt_BR/common/ls.md:27 MD047/single-trailing-newline Files should end with a single newline character

Please fix the error(s) and push again.

@Geipro Geipro added the new command Issues requesting creation of a new page. label Dec 5, 2019
Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for sticking with the review process, @BeLi4L!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants