Re: [PATCH 0/6] Improve remote helper documentation
On Fri, Dec 7, 2012 at 1:09 PM, Junio C Hamano gits...@pobox.com wrote: Max Horn m...@quendi.de writes: Various remote helper capabilities and commands were not documented, in particular 'export', or documented in a misleading way (e.g. 'for-push' was listed as a ref attribute understood by git, which is not the case). This patch series changes that, and also address some other things in the remote helper documentation that I found jarring when reading through it. Note that the description of export and (im|ex)port-marks probably can be improved, and I hope that somebody who knows more about them than me and/or is better at writing documentation will do just that. But I felt it was better to provide something than to do nothing and only complain, as I did previously on this subject ;-). A second ping to people who have touched transport-helper.c, remote-testsvn.c, git-remote-testgit, and contrib/remote-helpers/ in the past 18 months for comments. I've re-read the documentation updates myself and didn't find anything majorly objectionable. Except for a minor nit in 6/6; I think defined options should be defined attributes. I think the wording in 1/6 can be improved. Other than that I don't have any comments, what I'm familiar with looks good to me. -- Felipe Contreras -- To unsubscribe from this list: send the line unsubscribe git in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 0/6] Improve remote helper documentation
Max Horn m...@quendi.de writes: Various remote helper capabilities and commands were not documented, in particular 'export', or documented in a misleading way (e.g. 'for-push' was listed as a ref attribute understood by git, which is not the case). This patch series changes that, and also address some other things in the remote helper documentation that I found jarring when reading through it. Note that the description of export and (im|ex)port-marks probably can be improved, and I hope that somebody who knows more about them than me and/or is better at writing documentation will do just that. But I felt it was better to provide something than to do nothing and only complain, as I did previously on this subject ;-). A second ping to people who have touched transport-helper.c, remote-testsvn.c, git-remote-testgit, and contrib/remote-helpers/ in the past 18 months for comments. I've re-read the documentation updates myself and didn't find anything majorly objectionable. Except for a minor nit in 6/6; I think defined options should be defined attributes. --- a/Documentation/git-remote-helpers.txt +++ b/Documentation/git-remote-helpers.txt @@ -227,6 +227,8 @@ Support for this command is mandatory. the name; unrecognized attributes are ignored. The list ends with a blank line. + +See REF LIST ATTRIBUTES for a list of currently defined options. ++ -- To unsubscribe from this list: send the line unsubscribe git in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 0/6] Improve remote helper documentation
On Fri, Dec 7, 2012 at 11:09 AM, Junio C Hamano gits...@pobox.com wrote: A second ping to people who have touched transport-helper.c, remote-testsvn.c, git-remote-testgit, and contrib/remote-helpers/ in the past 18 months for comments. I've re-read the documentation updates myself and didn't find anything majorly objectionable. FWIW: Acked-by: Sverre Rabbelier srabbel...@gmail.com -- Cheers, Sverre Rabbelier -- To unsubscribe from this list: send the line unsubscribe git in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 0/6] Improve remote helper documentation
On 07.12.2012, at 20:09, Junio C Hamano wrote: Max Horn m...@quendi.de writes: Various remote helper capabilities and commands were not documented, in particular 'export', or documented in a misleading way (e.g. 'for-push' was listed as a ref attribute understood by git, which is not the case). This patch series changes that, and also address some other things in the remote helper documentation that I found jarring when reading through it. Note that the description of export and (im|ex)port-marks probably can be improved, and I hope that somebody who knows more about them than me and/or is better at writing documentation will do just that. But I felt it was better to provide something than to do nothing and only complain, as I did previously on this subject ;-). A second ping to people who have touched transport-helper.c, remote-testsvn.c, git-remote-testgit, and contrib/remote-helpers/ in the past 18 months for comments. I've re-read the documentation updates myself and didn't find anything majorly objectionable. Except for a minor nit in 6/6; I think defined options should be defined attributes. --- a/Documentation/git-remote-helpers.txt +++ b/Documentation/git-remote-helpers.txt @@ -227,6 +227,8 @@ Support for this command is mandatory. the name; unrecognized attributes are ignored. The list ends with a blank line. + +See REF LIST ATTRIBUTES for a list of currently defined options. ++ Indeed, my mistake. Dumb question since I am still not completely familiar with the procedures here: Would you just fix this yourself as you apply this, or is it better (or even required) that I reroll for this? (Of course if I ned to re-roll for other reasons, I'd fix this one as well). Thanks, Max-- To unsubscribe from this list: send the line unsubscribe git in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 0/6] Improve remote helper documentation
Max Horn m...@quendi.de writes: On 07.12.2012, at 20:09, Junio C Hamano wrote: Except for a minor nit in 6/6; I think defined options should be defined attributes. --- a/Documentation/git-remote-helpers.txt +++ b/Documentation/git-remote-helpers.txt @@ -227,6 +227,8 @@ Support for this command is mandatory. the name; unrecognized attributes are ignored. The list ends with a blank line. + +See REF LIST ATTRIBUTES for a list of currently defined options. ++ Indeed, my mistake. Dumb question since I am still not completely familiar with the procedures here: Would you just fix this yourself as you apply this, or is it better (or even required) that I reroll for this? (Of course if I ned to re-roll for other reasons, I'd fix this one as well). I didn't see any other issues myself, and I didn't see anybody raising issues on the series, either, so I could fix it up by amending what is already queued, as long as you are OK with it. Thanks. -- To unsubscribe from this list: send the line unsubscribe git in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 0/6] Improve remote helper documentation
On 07.12.2012, at 22:52, Junio C Hamano wrote: Max Horn m...@quendi.de writes: On 07.12.2012, at 20:09, Junio C Hamano wrote: Except for a minor nit in 6/6; I think defined options should be defined attributes. --- a/Documentation/git-remote-helpers.txt +++ b/Documentation/git-remote-helpers.txt @@ -227,6 +227,8 @@ Support for this command is mandatory. the name; unrecognized attributes are ignored. The list ends with a blank line. + +See REF LIST ATTRIBUTES for a list of currently defined options. ++ Indeed, my mistake. Dumb question since I am still not completely familiar with the procedures here: Would you just fix this yourself as you apply this, or is it better (or even required) that I reroll for this? (Of course if I ned to re-roll for other reasons, I'd fix this one as well). I didn't see any other issues myself, and I didn't see anybody raising issues on the series, either, so I could fix it up by amending what is already queued, as long as you are OK with it. Sure, I'd appreciate if you could make that fix. Thanks, Max -- To unsubscribe from this list: send the line unsubscribe git in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
[PATCH 0/6] Improve remote helper documentation
Various remote helper capabilities and commands were not documented, in particular 'export', or documented in a misleading way (e.g. 'for-push' was listed as a ref attribute understood by git, which is not the case). This patch series changes that, and also address some other things in the remote helper documentation that I found jarring when reading through it. Note that the description of export and (im|ex)port-marks probably can be improved, and I hope that somebody who knows more about them than me and/or is better at writing documentation will do just that. But I felt it was better to provide something than to do nothing and only complain, as I did previously on this subject ;-). Max Horn (6): Document invocation first, then input format Document missing remote helper capabilities Fix grammar Rearrange the description of remote helper capabilities Make clearer which commands must be supported for which capabilities Remove 'for-push' from ref list attributes list, link to subsections Documentation/git-remote-helpers.txt | 241 --- 1 file changed, 136 insertions(+), 105 deletions(-) -- 1.8.0.393.gcc9701d -- To unsubscribe from this list: send the line unsubscribe git in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
