Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

2018-06-28 Thread Jeff King
On Thu, Jun 28, 2018 at 12:36:06PM -0400, Todd Zullinger wrote: > >> It might be enough if the default values are relatively sane > >> and consistent. That would be a slight improvement over the > >> current situation still. > > > > Yeah. Taking a step back from the implementation questions, I t

Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

2018-06-28 Thread Todd Zullinger
ely be improved for readers of the .txt files. {system-wide-gitconfig} is likely better. Maybe the default for the generic paths could be /system-wide/git(config|attributes) too (or in CAPS to make it more obviously a placeholder)? Thanks for thinking this through and providing some good direct

Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

2018-06-28 Thread Jeff King
On Wed, Jun 27, 2018 at 04:58:43PM -0400, Todd Zullinger wrote: > I tend to think that the default should be to build > documentation that is accurate for that build, but since > it's something I'll set once for my package builds it's not > a big deal either way to me. To be clear, I think so, to

Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

2018-06-28 Thread Jeff King
On Wed, Jun 27, 2018 at 12:44:43PM -0400, Todd Zullinger wrote: > I wrote: > > Jeff King wrote: > >> (Related, there's a build target in the local Makefile for using > >> asciidoctor; does it need updated, too?) > > > > I didn't test asciidoctor specficially, but it also respects > > th

Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

2018-06-28 Thread Jeff King
On Wed, Jun 27, 2018 at 11:03:52AM -0400, Todd Zullinger wrote: > So what you're saying is that if I had procrastinated a > little, you may have written such a patch for me? :) Yes, but that's a dangerous game of chicken. :) > > 1. The pre-built documentation that Junio builds for > > qui

Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

2018-06-27 Thread Todd Zullinger
Junio C Hamano wrote: > Jeff King writes: > >> Specifically, I'm thinking of: >> >> 1. The pre-built documentation that Junio builds for >> quick-install-doc. This _could_ be customized during the "quick" >> step, but it's probably not worth the effort. However, we'd want >> some

Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

2018-06-27 Thread Junio C Hamano
Jeff King writes: > Specifically, I'm thinking of: > > 1. The pre-built documentation that Junio builds for > quick-install-doc. This _could_ be customized during the "quick" > step, but it's probably not worth the effort. However, we'd want > some kind of generic fill-in then, a

Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

2018-06-27 Thread Todd Zullinger
I wrote: > Jeff King wrote: >> (Related, there's a build target in the local Makefile for using >> asciidoctor; does it need updated, too?) > > I didn't test asciidoctor specficially, but it also respects > the ASCIIDOC_EXTRA parameters, so I think it will work just > as well. I'll try

Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

2018-06-27 Thread Todd Zullinger
Jeff King wrote: > On Wed, Jun 27, 2018 at 12:56:37AM -0400, Todd Zullinger wrote: > >> Replace `$(prefix)/etc/gitconfig` and `$(prefix)/etc/gitattributes` in >> generated documentation with the paths chosen when building. Readers of >> the documentation should not need to know how `$(prefix)` wa

Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

2018-06-27 Thread Jeff King
On Wed, Jun 27, 2018 at 12:56:37AM -0400, Todd Zullinger wrote: > Replace `$(prefix)/etc/gitconfig` and `$(prefix)/etc/gitattributes` in > generated documentation with the paths chosen when building. Readers of > the documentation should not need to know how `$(prefix)` was defined. Yes, I was j

[PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

2018-06-26 Thread Todd Zullinger
Replace `$(prefix)/etc/gitconfig` and `$(prefix)/etc/gitattributes` in generated documentation with the paths chosen when building. Readers of the documentation should not need to know how `$(prefix)` was defined. It's also more consistent than sometimes using `$(prefix)/etc/gitconfig` and other