Re: [Condor-devel] Cross-reference gittrac in the version history

[Todd Tannenbaum <tannenba@xxxxxxxxxxx>]

Hi All -

After thinking about the below, starting w/ new releases (i.e. v7.6.3 
and v7.7.1), I'd like the Version History to include the pointer to the 
gittrac ticket.  To be certain this happens consistently, and address 
the concerns Karen talked about below, I've documented new Version 
History guidelines at
   https://condor-wiki.cs.wisc.edu/index.cgi/wiki?p=VersionHistoryHowTo
Please take a couple minutes to read it.

The above mentions using a LaTeX macro "\Ticket{}" in version history 
entries - this macro now exists on V7_6-branch, V7_7_1-branch, and master.

thanks,
Todd

Matthew Farrellee wrote:
> I must be missing something here.
>
> The proposal is to give information as we always have AND a pointer to 
> the gritty details for users who are so inclined. This is purely the 
> addition of a link between two existing information streams. A link that 
> is currently difficult for people to make without deep knowledge of the 
> project and its developments.
>
> Best,
>
>
> matt
>
> On 08/09/2011 03:48 PM, Karen Miller wrote:
> > My view has always been that our manual is written for and accessible
> > to our users. These include many people who are not developers,
> > and ought not to be placed in a position of needing to search through
> > a gittrac ticket to find details. There are also those that cannot
> > do web access at the point in time where they might need to see what
> > was in that ticket you wish to refer to. A further point is that
> > the contents of our tickets are not generally the public face of our
> > project that we wish to present.
> >
> > So, no links/references to the tickets in the version history (other
> > than the obligatory ticket number in a comment). Give a brief
> > description. If there is further documentation that ought to be
> > present in the manual WRT ticket info, then we'll do that.
> >
> > Karen
> >
> > On 8/9/2011 2:00 PM, Matthew Farrellee wrote:
> > > I'm about to add some text to the 7-7.history.tex and I'd like to say
> > > "fixed blah blar blag, for details see gt#123", with an actual reference
> > > to gittrac. I see many entries have a gt# in comments but not the
> > > history entries themselves.
> > >
> > > What's accepted practice here? How can I reference gt from the version
> > > history?
> > >
> > > Best,
> > >
> > >
> > > matt
> > > _______________________________________________
> > > Condor-devel mailing list
> > > Condor-devel@xxxxxxxxxxx
> > > https://lists.cs.wisc.edu/mailman/listinfo/condor-devel
>
> _______________________________________________
> Condor-devel mailing list
> Condor-devel@xxxxxxxxxxx
> https://lists.cs.wisc.edu/mailman/listinfo/condor-devel


--
Todd Tannenbaum                       University of Wisconsin-Madison
Center for High Throughput Computing  Department of Computer Sciences
tannenba@xxxxxxxxxxx                  1210 W. Dayton St. Rm #4257
Phone: (608) 263-7132                 Madison, WI 53706-1685