[aerogear-dev] Asciidoc snippet Git hook

Karel Piwko kpiwko at redhat.com
Wed Feb 26 06:18:01 EST 2014


Makes perfect sense.

However, we need to agree on tag format. The hook might be useful no matter
the format, for instance to check that a tag is missing in latest commit. I'll
rework it next week to reflect that.

Karel

On Wed, 26 Feb 2014 09:51:53 +0100
Corinne Krych <corinnekrych at gmail.com> wrote:

> Hello Karel,
> 
> Yesterday, discussing with a friend who is writing his documentation using
> asciidoctor:
> http://beta.groovy-lang.org/docs/groovy-2.3.0-SNAPSHOT/html/documentation/
> 
> Instead of using line number, he uses tag in his documentation inclusion like:
> 
> [source,groovy]
> --------------------------------
> include::{projectdir}/src/spec/test/DifferencesFromJavaTest.groovy[tags=innerclass_3,indent=0]
> ————————————————
> 
> And in his code source he puts some tag like below:
> 
> // tag::innerclass_3[]
> public class Y {
>   public class X {}
>   public X foo() {
>   return new X()
>   }
>   public static X createX(Y y) {
>   return new X(y)
>   }
> }
> // end::innerclass_3[]
> 
> I think it worth a trial. wdyt?
> 
> ++
> Corinne
> 
> 
> On 21 Feb 2014, at 11:03, Karel Piwko <kpiwko at redhat.com> wrote:
> 
> > I've created following Git hook - 
> > https://github.com/kpiwko/asciidoc-git-hooks
> > 
> > Let me know if you like it and we can start using it improving our
> > documentation kept DRY experience.
> > 
> > Thanks,
> > 
> > Karel
> > _______________________________________________
> > aerogear-dev mailing list
> > aerogear-dev at lists.jboss.org
> > https://lists.jboss.org/mailman/listinfo/aerogear-dev
> 
> 
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev



More information about the aerogear-dev mailing list