Automated retrieval of SVN comments for documentation purpose

7 views
Skip to first unread message

Socrates Jr Cabales

unread,
May 17, 2023, 1:00:07 AM5/17/23
to tortois...@googlegroups.com
Hello Tortoise Dev Team,

We in our team wanted to create a documentation based on the comments that the members of the development team give each time they commit a code change to SVN.

Currently, we have set a standard format on how the development team should put their comments into SVN upon commit:

<Date of change>
<Module changed>
<Type of change - e.g. bug fix, enhancement, new feature, etc.>
<Entity changed - e.g. System, Database, API, User Interface, IIS, JAVA SDK, etc.>
<Change Description>

My question now are:
1. Would it be possible to develop an automated way where SVN retrieves all comments from a date range that we would define?
2. Once the comments from the date range have been gathered, is there a way where SVN can make a file containing the same details as the format of the comment I mentioned above.
3. Relative to question # 2, is there a way we can customize the contents of the file according to our needs. Then, once the file has been created, would we be able to save it in our local folders or directories?

Thank you and I hope to hear from you soon.

Regards,

Socrates G. Cabales, Jr.
Documentation Operations - Concentrix Philippines

Daniel Sahlberg

unread,
May 17, 2023, 2:46:11 AM5/17/23
to TortoiseSVN-dev
onsdag 17 maj 2023 kl. 07:00:07 UTC+2 skrev socrat...@gmail.com:
Hello Tortoise Dev Team,

We in our team wanted to create a documentation based on the comments that the members of the development team give each time they commit a code change to SVN.

Currently, we have set a standard format on how the development team should put their comments into SVN upon commit:

<Date of change>
<Module changed>
<Type of change - e.g. bug fix, enhancement, new feature, etc.>
<Entity changed - e.g. System, Database, API, User Interface, IIS, JAVA SDK, etc.>
<Change Description>

My question now are:
1. Would it be possible to develop an automated way where SVN retrieves all comments from a date range that we would define?

Try the command line client: svn log
(It is included with TortoiseSVN but you must select it in the installer)
Please check the SVN book at:

The --xml argument might be useful if you prefer to parse XML rather than plain text. 

2. Once the comments from the date range have been gathered, is there a way where SVN can make a file containing the same details as the format of the comment I mentioned above.

3. Relative to question # 2, is there a way we can customize the contents of the file according to our needs. Then, once the file has been created, would we be able to save it in our local folders or directories?

Yes, see the examples in #2.

Kind regards,
Daniel Sahlberg

Socrates Jr Cabales

unread,
May 23, 2023, 3:43:46 AM5/23/23
to TortoiseSVN-dev
Hello Daniel,

Thank you for the details you gave. I really appreciate them.

Another couple.of questions:
1. If ever we use command lines to.instruct SVN to retrieve comments for a specified date, how do we produce the code and where do we write them? In a notepad file.that can be run in SVN?
2. Is it possible that programming languages (Python, JAVA, etc.) could be used to prohram SVN to do something similar like.comments retrieval?

Thank you.

--
You received this message because you are subscribed to the Google Groups "TortoiseSVN-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tortoisesvn-d...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/tortoisesvn-dev/7f1c33e4-b475-490a-b197-c37243c314ean%40googlegroups.com.

Daniel Sahlberg

unread,
May 23, 2023, 9:02:32 AM5/23/23
to TortoiseSVN-dev
tisdag 23 maj 2023 kl. 09:43:46 UTC+2 skrev socrat...@gmail.com:
Hello Daniel,

Thank you for the details you gave. I really appreciate them.

Another couple.of questions:
1. If ever we use command lines to.instruct SVN to retrieve comments for a specified date, how do we produce the code and where do we write them? In a notepad file.that can be run in SVN?
2. Is it possible that programming languages (Python, JAVA, etc.) could be used to prohram SVN to do something similar like.comments retrieval?

The command line client is a standalone EXE file that should be called using whatever means your programming language provides. Python for example provide a few different ways in the os and subprocess modules. Exactly how you do this is probably out of scope for this forum.

 Kind regards,
Daniel
Reply all
Reply to author
Forward
0 new messages