[RFC|Accepted] Coding Guideline Modifications

These requests for comments/change have lead to an implemented feature that has been successfully merged into the 3.1/Ascraeus branch. Everything listed in this forum will be available in phpBB 3.1.
Post Reply
User avatar
igorw
Registered User
Posts: 500
Joined: Thu Jan 04, 2007 11:47 pm

Re: [RFC|Accepted] Coding Guideline Modifications

Post by igorw » Tue Sep 07, 2010 8:49 pm

ToonArmy wrote:Could we use the build script to set the @version information to the release version, it's always been kind of handy as a quick check.
Could be useful but it'd have to stay in sync, meaning changing all files with each update (or building something special into the auto updater). Not sure if it's worth the effort.
Use the built-in isset() function
Begin picky here, isset is not a function but a language construct. Looks good.

User avatar
EXreaction
Registered User
Posts: 1555
Joined: Sat Sep 10, 2005 2:15 am

Re: [RFC|Accepted] Coding Guideline Modifications

Post by EXreaction » Wed Sep 08, 2010 12:51 am

eviL3 wrote:
ToonArmy wrote:Could we use the build script to set the @version information to the release version, it's always been kind of handy as a quick check.
Could be useful but it'd have to stay in sync, meaning changing all files with each update (or building something special into the auto updater). Not sure if it's worth the effort.
I like the idea, but the auto-updater would be huge+, not the best for 3.1 I'd say. Maybe for 4.0.

sajaki
Registered User
Posts: 86
Joined: Mon Jun 21, 2010 8:28 pm

Re: [RFC|Accepted] Coding Guideline Modifications

Post by sajaki » Sun Sep 12, 2010 10:15 am

eviL3 wrote:The file header still needs to be adjusted. Currently it is:

Code: Select all

/**
*
* @package {PACKAGENAME}
* @version $Id: $
* @copyright (c) 2007 phpBB Group
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
*/
I'd suggest something among the lines of:

Code: Select all

/**
*
* @package {PACKAGENAME}
* @copyright (c) 2010 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU Public License, version 2
*
*/
This should only apply to files new to the develop (ascraeus) branch.
i would accept this change for phpbb core code, but for mods ?
I'm using SVN VCS (Googlecode), and so i don't see the point of removing * @version $Id: $.

User avatar
igorw
Registered User
Posts: 500
Joined: Thu Jan 04, 2007 11:47 pm

Re: [RFC|Accepted] Coding Guideline Modifications

Post by igorw » Sun Sep 12, 2010 10:22 am

MODs can of course retain the $Id$, this is just for the core.

User avatar
DavidIQ
Customisations Team Leader
Customisations Team Leader
Posts: 1753
Joined: Thu Mar 02, 2006 4:29 pm
Location: Earth
Contact:

Re: [RFC|Accepted] Coding Guideline Modifications

Post by DavidIQ » Mon Sep 13, 2010 2:26 am

sajaki wrote:i would accept this change for phpbb core code, but for mods ?
I'm using SVN VCS (Googlecode), and so i don't see the point of removing * @version $Id: $.
I don't foresee us enforcing this at all for MODs so don't worry about it. While we have decided to use github, which is part of the reason we are removing this line, everyone else can use whatever service they'd like to use (SF, GCode, etc.) so this part of the guidelines may not apply for all MOD writers anyways.
Image

User avatar
nickvergessen
Former Team Member
Posts: 733
Joined: Sun Oct 07, 2007 11:54 am
Location: Stuttgart, Germany
Contact:

Re: [RFC|Accepted] Coding Guideline Modifications

Post by nickvergessen » Mon Sep 13, 2010 8:50 am

EXreaction wrote:
eviL3 wrote:
ToonArmy wrote:Could we use the build script to set the @version information to the release version, it's always been kind of handy as a quick check.
Could be useful but it'd have to stay in sync, meaning changing all files with each update (or building something special into the auto updater). Not sure if it's worth the effort.
I like the idea, but the auto-updater would be huge+, not the best for 3.1 I'd say. Maybe for 4.0.
if we only do that, for files that got changed, it should be not much more work than it is now right?
Member of the Development-TeamNo Support via PM

User avatar
naderman
Consultant
Posts: 1727
Joined: Sun Jan 11, 2004 2:11 am
Location: Karlsruhe, Germany
Contact:

Re: [RFC|Accepted] Coding Guideline Modifications

Post by naderman » Fri Sep 17, 2010 2:25 pm

ToonArmy wrote:Could we use the build script to set the @version information to the release version, it's always been kind of handy as a quick check.
I'm not sure we should do that. The info is rather unreliable cause the file might still have been changed.

User avatar
igorw
Registered User
Posts: 500
Joined: Thu Jan 04, 2007 11:47 pm

Re: [RFC|Accepted] Coding Guideline Modifications

Post by igorw » Sun Sep 19, 2010 9:39 am

I adjusted my suggestion. The old line read "GNU Public License", the name of the license really is "GNU General Public License" though.

User avatar
bantu
3.0 Release Manager
3.0 Release Manager
Posts: 557
Joined: Thu Sep 07, 2006 11:22 am
Location: Karlsruhe, Germany
Contact:

Re: [RFC|Accepted] Coding Guideline Modifications

Post by bantu » Thu Dec 16, 2010 1:43 am

I suggest removing $Id$ from all files just as we removed the ?> lines.

User avatar
igorw
Registered User
Posts: 500
Joined: Thu Jan 04, 2007 11:47 pm

Re: [RFC|Accepted] Coding Guideline Modifications

Post by igorw » Fri Dec 17, 2010 2:31 pm


Post Reply