Discussion:
[Libreoffice-bugs] [Bug 90834] New: Turn in-line version control history comments into meaningful good comments
b***@bugs.documentfoundation.org
2015-04-24 13:55:26 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

Bug ID: 90834
Summary: Turn in-line version control history comments into
meaningful good comments
Product: LibreOffice
Version: 4.5.0.0.alpha0+ Master
Hardware: Other
OS: All
Status: UNCONFIRMED
Severity: minor
Priority: medium
Component: LibreOffice
Assignee: libreoffice-***@lists.freedesktop.org
Reporter: ***@iki.fi

Especially in sw we have lots of comments, mainly by a person called "OD", but
possibly also others, inherited from OpenOffice.org times, that go like this:

// OD 06.08.2002 #99657# - add 6th parameter to indicate,
if
// background transparency have to be considered
// Set missing 5th parameter to the default value
GRFNUM_NO
// - see declaration in /core/inc/frmtool.hxx.

These basically are in-line version control comments: They tell what change was
done to the code at that date, and by whom. That is not information that should
be in the source code (but recorded in the version control system). When
possible, such comments should be changed to tell what the code does, using the
present tense. The above could turn into something like:

// The 6th parameter indicates if
// background transparency have to be considered.
// See declaration in /core/inc/frmtool.hxx.

In other cases, like:

// OD 05.09.2002 #102912#
// delete temporary background brush.
delete pTmpBackBrush;

it's just the timestamp and bug number that should be removed. They are not
interesting.

// delete temporary background brush.
delete pTmpBackBrush;

In cases like:

// --> OD #i102707#
namespace
{
...
}
// <--

the comments are not useful at all and should simply be deleted.

Obviously exactly what to do with these "OD" comments is a matter of taste...
If you plan to work on it, please submit an initial suggestion with perhaps a
dozen or so comments handled for review, before wasting time on doing hundreds
of cases in perhaps the "wrong" way.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2015-04-24 13:55:41 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

Tor Lillqvist <***@iki.fi> changed:

What |Removed |Added
----------------------------------------------------------------------------
Whiteboard| |EasyHack SkillCpp
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2015-04-24 14:15:32 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

Miklos Vajna <***@collabora.co.uk> changed:

What |Removed |Added
----------------------------------------------------------------------------
Status|UNCONFIRMED |NEW
Ever confirmed|0 |1

--- Comment #1 from Miklos Vajna <***@collabora.co.uk> ---
Confirming. Though please don't just delete these comments as-is, the OOo
bugzilla references are still useful, e.g. changing

// --> OD #i102707#
// <--

to a single

// i#102707

is what I would suggest. Names, dates, arrows can go. Also #12345# bug numbers
refer to the lost stardiv bugzilla, so those can go, too.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2015-10-08 19:07:14 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

yeliz <***@gmail.com> changed:

What |Removed |Added
----------------------------------------------------------------------------
Assignee|libreoffice-***@lists.free |***@gmail.com
|desktop.org |
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-03-20 19:46:59 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

Tor Lillqvist <***@iki.fi> changed:

What |Removed |Added
----------------------------------------------------------------------------
Assignee|***@gmail.com |libreoffice-***@lists.free
| |desktop.org

--- Comment #8 from Tor Lillqvist <***@iki.fi> ---
Muhammad, good good!

yeliz, I assume you aren't working on this any longer, you assigned the bug to
yourself in October, but did just one commit. For bugs like this, that many
people can work on, as there are dozens or hundreds of separate changes that
can be done, assigning it to one person is not useful.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-03-20 19:47:21 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

--- Comment #9 from Tor Lillqvist <***@iki.fi> ---
Ah, sorry, autocorrect "fixed" your first name;)
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-03-22 16:32:23 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

--- Comment #10 from Commit Notification <libreoffice-***@lists.freedesktop.org> ---
Muhammet Kara committed a patch related to this issue.
It has been pushed to "master":

http://cgit.freedesktop.org/libreoffice/core/commit/?id=da966b5e49e49beb29be5fbdb092ad36dc7fa0ff

tdf#90834 Cleanup in-line version control history comments: widorp.cxx

It will be available in 5.2.0.

The patch should be included in the daily builds available at
http://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
http://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-03-23 17:35:37 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

--- Comment #11 from Commit Notification <libreoffice-***@lists.freedesktop.org> ---
Muhammet Kara committed a patch related to this issue.
It has been pushed to "master":

http://cgit.freedesktop.org/libreoffice/core/commit/?id=8e9658b43153f20f644c053cf7ffe5c7883dd14d

tdf#90834 Cleanup in-line version control history comments

It will be available in 5.2.0.

The patch should be included in the daily builds available at
http://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
http://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-04-01 06:25:53 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

--- Comment #12 from Commit Notification <libreoffice-***@lists.freedesktop.org> ---
Muhammet Kara committed a patch related to this issue.
It has been pushed to "master":

http://cgit.freedesktop.org/libreoffice/core/commit/?id=20f98f52392504666c467417558fdf93e3c16c27

tdf#90834 Cleanup in-line version control history comments

It will be available in 5.2.0.

The patch should be included in the daily builds available at
http://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
http://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-04-01 06:28:30 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

--- Comment #13 from Commit Notification <libreoffice-***@lists.freedesktop.org> ---
Muhammet Kara committed a patch related to this issue.
It has been pushed to "master":

http://cgit.freedesktop.org/libreoffice/core/commit/?id=403793990c1258db5b2bc4f709e6028a3d5ea2cb

tdf#90834 Cleanup in-line version control history comments

It will be available in 5.2.0.

The patch should be included in the daily builds available at
http://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
http://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-04-29 05:55:07 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

jan iversen <***@documentfoundation.org> changed:

What |Removed |Added
----------------------------------------------------------------------------
Whiteboard|ToBeReviewed target:5.2.0 |target:5.2.0
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-06-02 15:57:58 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

Commit Notification <libreoffice-***@lists.freedesktop.org> changed:

What |Removed |Added
----------------------------------------------------------------------------
Whiteboard|target:5.2.0 |target:5.2.0 target:5.3.0
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-06-02 15:58:01 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

--- Comment #14 from Commit Notification <libreoffice-***@lists.freedesktop.org> ---
krishna keshav committed a patch related to this issue.
It has been pushed to "master":

http://cgit.freedesktop.org/libreoffice/core/commit/?id=66c41718f91dcca9c487742e9313c657ede4ce3f

tdf#90834 Turn in-line version control history comments

It will be available in 5.3.0.

The patch should be included in the daily builds available at
http://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
http://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-06-10 08:27:09 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

--- Comment #15 from Commit Notification <libreoffice-***@lists.freedesktop.org> ---
apurvapriyadarshi committed a patch related to this issue.
It has been pushed to "master":

http://cgit.freedesktop.org/libreoffice/core/commit/?id=8970f569f1309d16d3686c75925810c94504f891

tdf#90834 Turn in-line version control history comments

It will be available in 5.3.0.

The patch should be included in the daily builds available at
http://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
http://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-06-14 10:01:36 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

--- Comment #16 from jan iversen <***@documentfoundation.org> ---
Controlled, still open
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-06-20 05:23:15 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

--- Comment #17 from Commit Notification <libreoffice-***@lists.freedesktop.org> ---
apurvapriyadarshi committed a patch related to this issue.
It has been pushed to "master":

http://cgit.freedesktop.org/libreoffice/core/commit/?id=ef5b37726335034de44e6e7cc2035f798d66f753

tdf#90834 Turn in-line version control

It will be available in 5.3.0.

The patch should be included in the daily builds available at
http://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
http://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-07-05 06:16:01 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

--- Comment #18 from Commit Notification <libreoffice-***@lists.freedesktop.org> ---
krishna keshav committed a patch related to this issue.
It has been pushed to "master":

http://cgit.freedesktop.org/libreoffice/core/commit/?id=9b95f149b2a98df33710d5caf460575d8ee6ab52

tdf#90834 Turn in-line version control history comments

It will be available in 5.3.0.

The patch should be included in the daily builds available at
http://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
http://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2016-08-05 09:21:03 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

jan iversen <***@documentfoundation.org> changed:

What |Removed |Added
----------------------------------------------------------------------------
Status|NEW |NEEDINFO

--- Comment #19 from jan iversen <***@documentfoundation.org> ---
Please be aware, that this easyhack is considered an important but large scale
cosmetic change as described in
https://wiki.documentfoundation.org/Development/LargeScaleChanges

It was in decided by the ESC to close this kind of easyhacks, and send them
directly as mail, to new contributors.
https://lists.freedesktop.org/archives/libreoffice/2016-August/074920.html

Please do not submit patches with many files !!

This easyhacks should/will be opened, when we have a window to do largescale
changes.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2018-04-10 05:21:42 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

Commit Notification <libreoffice-***@lists.freedesktop.org> changed:

What |Removed |Added
----------------------------------------------------------------------------
Whiteboard|target:5.2.0 target:5.3.0 |target:5.2.0 target:5.3.0
| |target:6.1.0
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2018-04-10 05:21:45 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

--- Comment #21 from Commit Notification <libreoffice-***@lists.freedesktop.org> ---
Gökhan Gurbetoğlu committed a patch related to this issue.
It has been pushed to "master":

http://cgit.freedesktop.org/libreoffice/core/commit/?id=c9292c0d370ca779a4f3351bafc8988363679dc1

tdf#90834 Cleanup version control history comments

It will be available in 6.1.0.

The patch should be included in the daily builds available at
http://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
http://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
--
You are receiving this mail because:
You are the assignee for the bug.
b***@bugs.documentfoundation.org
2018-12-11 09:56:41 UTC
Permalink
https://bugs.documentfoundation.org/show_bug.cgi?id=90834

Bart Terpstra <***@protonmail.com> changed:

What |Removed |Added
----------------------------------------------------------------------------
Assignee|libreoffice-***@lists.free |***@protonmail.com
|desktop.org |
--
You are receiving this mail because:
You are the assignee for the bug.
Fortsæt læsning på narkive:
Loading...