Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.This crops up periodically... The line
@defgroup updates-7.x-to-8.x Updates from 7.x to 8.x
gets copied from system.install to other .install files.
It appears that it is currently in toolbar.install and shortcut.install.
That is not good. They should have @addtogroup instead of @defgroup.
See
http://drupal.org/node/1354#groups
for details of syntax.
So this project is:
a) Find all instances of @defgroup updates-7.x-to-8.x in core
b) Make sure there is just one (probably the one that I think is in system.install) by changing the others to @addtogroup.
c) Maybe put a code comment just before the @defgroup documentation block in system.install telling people NOT TO COPY that @defgroup block any more. Please. Politely. :)
Should be a good Novice project.
| Comment | File | Size | Author |
|---|---|---|---|
| #15 | 1899460-duplicate-defgroup-15.patch | 1.64 KB | chrisjlee |
| #13 | 1899460-duplicate-defgroup-6.patch | 1.63 KB | richard.c.allen2386 |
| #10 | 1899460-duplicate-defgroup-5.patch | 1.67 KB | richard.c.allen2386 |
| #8 | 1899460-duplicate-defgroup-4.patch | 1.71 KB | richard.c.allen2386 |
| #4 | 1899460-duplicate-defgroup-3.patch | 1.44 KB | chrisjlee |
Comments
Comment #1
chrisjlee CreditAttribution: chrisjlee commentedTry this? I hope the message was friendly enough.
Comment #2
chrisjlee CreditAttribution: chrisjlee commentedOops left some trailing whitespace. Try again. also need to change status...
Comment #4
chrisjlee CreditAttribution: chrisjlee commentednot sure why it failed. I guess i'm making this more complicated than it is. try again.
Comment #6
chrisjlee CreditAttribution: chrisjlee commented#4: 1899460-duplicate-defgroup-3.patch queued for re-testing.
Comment #7
jhodgdonThanks! But what I'd actually like to happen:
a) Change the two @defgroup sections to @addtogroup (they don't need that comment).
b) Put a // comment before the @defgroup **in system.install** that says not to copy the defgroup to other files, and to use @addtogroup instead.
I don't think we've had problems with @addtogroup sections being changed to @defgroup. I think we've had problems where people have copied an existing @defgroup from system.install. At least, that is what I think is happening...
Comment #8
richard.c.allen2386 CreditAttribution: richard.c.allen2386 commentedTried re-rolling the patch. Is this what you are looking for? Let me know if there is something funny, first core commit.
Comment #9
jhodgdonLooks great, thanks! Somehow an extra line got added to the defgroup documentation block in system.install though. If you can get rid of that, I think we'll be done.
Comment #10
richard.c.allen2386 CreditAttribution: richard.c.allen2386 commentedYup somehow it got added in there. Here you go.
Comment #11
richard.c.allen2386 CreditAttribution: richard.c.allen2386 commentedForget to set issue.
Comment #12
jhodgdonOh wait... I just noticed one other thing. When we do a @defgroup, we have to put in a human-readable name for the topic, and then a longer description. @addtogroup should not have this information. The proper syntax is just:
and then a blank line, and then the function docs/definitions should follow. See
http://drupal.org/node/1354#groups
Comment #13
richard.c.allen2386 CreditAttribution: richard.c.allen2386 commentedI'm learning the doxygen stuff now so I think this is what you meant?
Comment #14
jhodgdonJust about! Here's what you currently have:
That last line with the description ("Update functions ...") also needs to be removed. Thanks!
Comment #15
chrisjlee CreditAttribution: chrisjlee commentedLike that? Sorry i misunderstood before.
Comment #16
jhodgdonThanks! That's it exactly. Committed to 8.x.