Closed (fixed)
Project:
Documentation
Component:
Correction/Clarification
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
10 Mar 2008 at 04:03 UTC
Updated:
17 Jan 2009 at 18:50 UTC
A line should be added to .info files for themes explaining how to properly package your theme for distribution by including the $Id marker.
Comments
Comment #1
todd nienkerk commented*** Accidentally posted a new issue as a comment to this one. Sorry -- will fix. ***
Comment #2
todd nienkerk commentedFixing the mess I made. Apologies.
Comment #3
todd nienkerk commentedPerhaps an explanation of $Id is also warranted on the Adding your theme to Drupal.org page.
Comment #4
dvessel commentedThis would be nice to add to the coding standards then linking to them from the "adding your theme" page. Since $id can be used across all files, it shouldn't just note this for .info files but make a note on how it must be commented out for each type.
Comment #5
dvessel commentedAre you going to take care of this? If not, un-assign yourself.
Comment #6
todd nienkerk commented@dvessel: Unassigning myself now.
Comment #7
webchickAgreed with dvessel, we should document this once, refer to it from elsewhere.
But the coding standards does have a "Header Comment Blocks" section, which states:
"
All source code files in the core Drupal distribution should contain the following comment block as the header:
<?php
// $Id$
This tag will be expanded by the CVS to contain useful information
<?php
// $Id: CODING_STANDARDS.html,v 1.14 2008/02/19 03:36:41 ax Exp $
"
What about this is unclear and needs to be worded better? Or is it just that we need a pointer here from the theme docs?
Comment #8
todd nienkerk commented@webchick: Sorry, I should have been more clear about the scope of my request.
(1) I think there should be a single page that explains the use of $Id in every instance where it could appear (.module, .info, .css, etc. files).
(2) The example you cite above is helpful, but I think it's a bit vague when it qualifies the use of $Id in "core Drupal distribution." It's not immediately clear to the contributor if (a) that statement applies to them (their module isn't core) and (b) where/how they place $Id in .module, .info, .css, and other files. (dvessel touches on this above.)
Comment #9
webchickOk, then. Probably the best place to add this is as a child-page to the coding standards page. That would be consistent with other child pages that elaborate on things in the coding standards.
Comment #10
add1sun commentedThis is clarified in http://drupal.org/node/546 and I added a link to the "Adding your theme" page. The entire section needs reorg'd/consolidated and that is being addressed in another issue: #30034: Codings standards cleanup so this is fixed.