Adding "Change History" To Clojure Modules
Is there a preferred method for adding a Change History block to a
Clojure module? I'm doing this for now:
(ns addr-verify
^{:author "Charles M. Norton",
:doc "addr-verify is a small Clojure program that runs address
verification through ...
Created on August 3, 2011
Change History: "}
(:gen-class)
.
.
.
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
Re: Adding "Change History" To Clojure Modules
changelog.txt / VCS?
2011/8/3 octopusgrabbus :
> Is there a preferred method for adding a Change History block to a
> Clojure module? I'm doing this for now:
>
> (ns addr-verify
> ^{:author "Charles M. Norton",
> :doc "addr-verify is a small Clojure program that runs address
> verification through ...
>
> Created on August 3, 2011
> Change History: "}
> (:gen-class)
> .
> .
> .
>
> --
> You received this message because you are subscribed to the Google
> Groups "Clojure" group.
> To post to this group, send email to clojure@googlegroups.com
> Note that posts from new members are moderated - please be patient with your
> first post.
> To unsubscribe from this group, send email to
> clojure+unsubscr...@googlegroups.com
> For more options, visit this group at
> http://groups.google.com/group/clojure?hl=en
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
Re: Adding "Change History" To Clojure Modules
Thanks, and I'm searching as to how to get cvs commit to write this
into the module. If you know that, it would be so helpful.
On Aug 3, 3:31 pm, Joop Kiefte wrote:
> changelog.txt / VCS?
>
> 2011/8/3 octopusgrabbus :
>
>
>
>
>
>
>
> > Is there a preferred method for adding a Change History block to a
> > Clojure module? I'm doing this for now:
>
> > (ns addr-verify
> > ^{:author "Charles M. Norton",
> > :doc "addr-verify is a small Clojure program that runs address
> > verification through ...
>
> > Created on August 3, 2011
> > Change History: "}
> > (:gen-class)
> > .
> > .
> > .
>
> > --
> > You received this message because you are subscribed to the Google
> > Groups "Clojure" group.
> > To post to this group, send email to clojure@googlegroups.com
> > Note that posts from new members are moderated - please be patient with
> > your first post.
> > To unsubscribe from this group, send email to
> > clojure+unsubscr...@googlegroups.com
> > For more options, visit this group at
> >http://groups.google.com/group/clojure?hl=en
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
Re: Adding "Change History" To Clojure Modules
I think Joop meant to use the change history in your version control system
directly, rather than try to put it into the source code.
I think the prevailing best practices these days are to _not_ duplicate
change history into source code, even thru VCS keyword substitution. The
change history is available in the VCS already and also in your IDE, so
anyone who needs to know how a given file has changed can go look that up.
Sean
On Wed, Aug 3, 2011 at 12:29 PM, octopusgrabbus wrote:
> Is there a preferred method for adding a Change History block to a
> Clojure module? I'm doing this for now:
>
> (ns addr-verify
> ^{:author "Charles M. Norton",
>:doc "addr-verify is a small Clojure program that runs address
> verification through ...
>
> Created on August 3, 2011
> Change History: "}
> (:gen-class)
>
>
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
Re: Adding "Change History" To Clojure Modules
This. 1000 times this.
Don't clutter your source code with this kind of stuff. It'll just
cause you pain down the road. (Say, when merging two branches.)
// ben
On Wed, Aug 3, 2011 at 23:36, Sean Corfield wrote:
> I think Joop meant to use the change history in your version control system
> directly, rather than try to put it into the source code.
> I think the prevailing best practices these days are to _not_ duplicate
> change history into source code, even thru VCS keyword substitution. The
> change history is available in the VCS already and also in your IDE, so
> anyone who needs to know how a given file has changed can go look that up.
> Sean
> On Wed, Aug 3, 2011 at 12:29 PM, octopusgrabbus
> wrote:
>>
>> Is there a preferred method for adding a Change History block to a
>> Clojure module? I'm doing this for now:
>>
>> (ns addr-verify
>> ^{:author "Charles M. Norton",
>> :doc "addr-verify is a small Clojure program that runs address
>> verification through ...
>>
>> Created on August 3, 2011
>> Change History: "}
>> (:gen-class)
>>
>
> --
> You received this message because you are subscribed to the Google
> Groups "Clojure" group.
> To post to this group, send email to clojure@googlegroups.com
> Note that posts from new members are moderated - please be patient with your
> first post.
> To unsubscribe from this group, send email to
> clojure+unsubscr...@googlegroups.com
> For more options, visit this group at
> http://groups.google.com/group/clojure?hl=en
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
Re: Adding "Change History" To Clojure Modules
That was exactly what I meant. Sorry for not responding directly to
the second inquiry, I wanted to see if others thought the same about
this...
2011/8/3 Ben Smith-Mannschott :
> This. 1000 times this.
>
> Don't clutter your source code with this kind of stuff. It'll just
> cause you pain down the road. (Say, when merging two branches.)
>
> // ben
>
> On Wed, Aug 3, 2011 at 23:36, Sean Corfield wrote:
>> I think Joop meant to use the change history in your version control system
>> directly, rather than try to put it into the source code.
>> I think the prevailing best practices these days are to _not_ duplicate
>> change history into source code, even thru VCS keyword substitution. The
>> change history is available in the VCS already and also in your IDE, so
>> anyone who needs to know how a given file has changed can go look that up.
>> Sean
>> On Wed, Aug 3, 2011 at 12:29 PM, octopusgrabbus
>> wrote:
>>>
>>> Is there a preferred method for adding a Change History block to a
>>> Clojure module? I'm doing this for now:
>>>
>>> (ns addr-verify
>>> ^{:author "Charles M. Norton",
>>> :doc "addr-verify is a small Clojure program that runs address
>>> verification through ...
>>>
>>> Created on August 3, 2011
>>> Change History: "}
>>> (:gen-class)
>>>
>>
>> --
>> You received this message because you are subscribed to the Google
>> Groups "Clojure" group.
>> To post to this group, send email to clojure@googlegroups.com
>> Note that posts from new members are moderated - please be patient with your
>> first post.
>> To unsubscribe from this group, send email to
>> clojure+unsubscr...@googlegroups.com
>> For more options, visit this group at
>> http://groups.google.com/group/clojure?hl=en
>
> --
> You received this message because you are subscribed to the Google
> Groups "Clojure" group.
> To post to this group, send email to clojure@googlegroups.com
> Note that posts from new members are moderated - please be patient with your
> first post.
> To unsubscribe from this group, send email to
> clojure+unsubscr...@googlegroups.com
> For more options, visit this group at
> http://groups.google.com/group/clojure?hl=en
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
Re: Adding "Change History" To Clojure Modules
On Wed, Aug 3, 2011 at 12:48 PM, octopusgrabbus wrote: > Thanks, and I'm searching as to how to get cvs commit to write this > into the module. If you know that, it would be so helpful. > The consensus seems to be: don't do that. -- Sean A Corfield -- (904) 302-SEAN An Architect's View -- http://corfield.org/ World Singles, LLC. -- http://worldsingles.com/ Railo Technologies, Inc. -- http://www.getrailo.com/ "Perfection is the enemy of the good." -- Gustave Flaubert, French realist novelist (1821-1880) -- You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en
Re: Adding "Change History" To Clojure Modules
Hi
On 3 August 2011 21:29, octopusgrabbus wrote:
> Is there a preferred method for adding a Change History block to a
> Clojure module? I'm doing this for now:
>
> (ns addr-verify
> ^{:author "Charles M. Norton",
> :doc "addr-verify is a small Clojure program that runs address
> verification through ...
>
> Created on August 3, 2011
> Change History: "}
> (:gen-class)
Others have commented on the change history, but for the "created on"
or something similar, you can do the following, as is done in the
Clojure source code:
(defn with-redefs-fn
"some doc string"
{:added "1.3"}
[binding-map func]
[...]
Here ":added" refers to the version of Clojure it was added in rather
than a specific date, but for a function, that often makes more sense,
I think. You should be able to do something similar for the
namespace.
--
Michael Wood
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
Re: Adding "Change History" To Clojure Modules
We have a fairly simple development environment here, not that it
couldn't stand updating, but other than a consultant, I am the only
developer. I need changes written directly into each file. and here is
why.
When I got here over seven years ago, there were well over 200 4GL
modules and a smattering of C modules built into Informix's customized
runner for 4GL pcode. Almost no module had comments; and almost no
module had module header information. We also had no formal build.
Yes, I could look things up in CVS, but I find it better to have stuff
written in the header.
I'm using $Log$, and it works.
Thanks.
On Aug 3, 5:36 pm, Sean Corfield wrote:
> I think Joop meant to use the change history in your version control system
> directly, rather than try to put it into the source code.
>
> I think the prevailing best practices these days are to _not_ duplicate
> change history into source code, even thru VCS keyword substitution. The
> change history is available in the VCS already and also in your IDE, so
> anyone who needs to know how a given file has changed can go look that up.
>
> Sean
>
> On Wed, Aug 3, 2011 at 12:29 PM, octopusgrabbus
> wrote:
>
>
>
>
>
>
>
> > Is there a preferred method for adding a Change History block to a
> > Clojure module? I'm doing this for now:
>
> > (ns addr-verify
> > ^{:author "Charles M. Norton",
> > :doc "addr-verify is a small Clojure program that runs address
> > verification through ...
>
> > Created on August 3, 2011
> > Change History: "}
> > (:gen-class)
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
Re: Adding "Change History" To Clojure Modules
In that case I would suggest putting it on top of the file more
or less like this
with a lot of ;'s at the start. You could create a script to
update that automatically
from the CVS I suppose, and if you make sure it's autogenerated
and that it comes
from the CVS it gives a lot more insight for both sides. But
that's my opinion.
At least I wouldn't put it in the docstring.
(ns code-starts-here ...)
2011/8/4 octopusgrabbus :
> We have a fairly simple development environment here, not that it
> couldn't stand updating, but other than a consultant, I am the only
> developer. I need changes written directly into each file. and here is
> why.
>
> When I got here over seven years ago, there were well over 200 4GL
> modules and a smattering of C modules built into Informix's customized
> runner for 4GL pcode. Almost no module had comments; and almost no
> module had module header information. We also had no formal build.
>
> Yes, I could look things up in CVS, but I find it better to have stuff
> written in the header.
>
> I'm using $Log$, and it works.
>
> Thanks.
>
> On Aug 3, 5:36 pm, Sean Corfield wrote:
>> I think Joop meant to use the change history in your version control system
>> directly, rather than try to put it into the source code.
>>
>> I think the prevailing best practices these days are to _not_ duplicate
>> change history into source code, even thru VCS keyword substitution. The
>> change history is available in the VCS already and also in your IDE, so
>> anyone who needs to know how a given file has changed can go look that up.
>>
>> Sean
>>
>> On Wed, Aug 3, 2011 at 12:29 PM, octopusgrabbus
>> wrote:
>>
>>
>>
>>
>>
>>
>>
>> > Is there a preferred method for adding a Change History block to a
>> > Clojure module? I'm doing this for now:
>>
>> > (ns addr-verify
>> > ^{:author "Charles M. Norton",
>> > :doc "addr-verify is a small Clojure program that runs address
>> > verification through ...
>>
>> > Created on August 3, 2011
>> > Change History: "}
>> > (:gen-class)
>
> --
> You received this message because you are subscribed to the Google
> Groups "Clojure" group.
> To post to this group, send email to clojure@googlegroups.com
> Note that posts from new members are moderated - please be patient with your
> first post.
> To unsubscribe from this group, send email to
> clojure+unsubscr...@googlegroups.com
> For more options, visit this group at
> http://groups.google.com/group/clojure?hl=en
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
Re: Adding "Change History" To Clojure Modules
Thanks. This makes more sense putting it there.
On Aug 4, 10:46 am, Joop Kiefte wrote:
> In that case I would suggest putting it on top of the file more
> or less like this
> with a lot of ;'s at the start. You could create a script to
> update that automatically
> from the CVS I suppose, and if you make sure it's autogenerated
> and that it comes
> from the CVS it gives a lot more insight for both sides. But
> that's my opinion.
> At least I wouldn't put it in the docstring.
>
> (ns code-starts-here ...)
>
> 2011/8/4 octopusgrabbus :
>
>
>
>
>
>
>
> > We have a fairly simple development environment here, not that it
> > couldn't stand updating, but other than a consultant, I am the only
> > developer. I need changes written directly into each file. and here is
> > why.
>
> > When I got here over seven years ago, there were well over 200 4GL
> > modules and a smattering of C modules built into Informix's customized
> > runner for 4GL pcode. Almost no module had comments; and almost no
> > module had module header information. We also had no formal build.
>
> > Yes, I could look things up in CVS, but I find it better to have stuff
> > written in the header.
>
> > I'm using $Log$, and it works.
>
> > Thanks.
>
> > On Aug 3, 5:36 pm, Sean Corfield wrote:
> >> I think Joop meant to use the change history in your version control system
> >> directly, rather than try to put it into the source code.
>
> >> I think the prevailing best practices these days are to _not_ duplicate
> >> change history into source code, even thru VCS keyword substitution. The
> >> change history is available in the VCS already and also in your IDE, so
> >> anyone who needs to know how a given file has changed can go look that up.
>
> >> Sean
>
> >> On Wed, Aug 3, 2011 at 12:29 PM, octopusgrabbus
> >> wrote:
>
> >> > Is there a preferred method for adding a Change History block to a
> >> > Clojure module? I'm doing this for now:
>
> >> > (ns addr-verify
> >> > ^{:author "Charles M. Norton",
> >> > :doc "addr-verify is a small Clojure program that runs address
> >> > verification through ...
>
> >> > Created on August 3, 2011
> >> > Change History: "}
> >> > (:gen-class)
>
> > --
> > You received this message because you are subscribed to the Google
> > Groups "Clojure" group.
> > To post to this group, send email to clojure@googlegroups.com
> > Note that posts from new members are moderated - please be patient with
> > your first post.
> > To unsubscribe from this group, send email to
> > clojure+unsubscr...@googlegroups.com
> > For more options, visit this group at
> >http://groups.google.com/group/clojure?hl=en
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
