Christian Couder <christian.couder@xxxxxxxxx> writes: > On Sat, Sep 9, 2023 at 12:55 AM Linus Arver <linusa@xxxxxxxxxx> wrote: >> >> Hi Christian, >> >> I am only reviewing the docs. To assume the mindset of a Git user >> unfamiliar with this command, I purposely did not read the cover letter >> until after this review was done. > > Ok, thanks! > > [...] >> > + Starting point at which to create the new commits. May be any >> > + valid commit, and not just an existing branch name. >> >> Add "See linkgit:gitrevisions[7]." at the end? > > I don't think it's worth it to mention "linkgit:gitrevisions[7]" > everywhere we can pass a revision. I think it makes the doc heavier > than it should be, especially here where the command is a plumbing one > for now and users should be quite experienced with Git already. I agree that plumbing commands assume that users are more experienced with Git already, so SGTM. >> I ask because I'm interested in informing >> the readers of our docs about any potential pitfalls from abusing this >> command by mistake. > > I appreciate your desire to give high quality docs to our users, but I > don't think it's a big pitfall and I think that this command is still > very much "in the works" and is also designed for experienced users > for now, so I am not sure it's the right time to spend too much time > on this. Also sounds reasonable to me. Thank you for considering my suggestions, much appreciated!
