[otrs-cvs] doc-developer/en/content/contributing/code-style-guide perl.xml, 1.4, 1.5
"CVS commits notifications of OTRS.org" <[email protected]>
| Newsgroups | gmane.comp.otrs.cvs |
|---|---|
| Message-ID | <[email protected]> |
Comments:
Update of /home/cvs/doc-developer/en/content/contributing/code-style-guide
In directory lancelot:/tmp/cvs-serv17009/en/content/contributing/code-style-guide
Modified Files:
perl.xml
Log Message:
Removed '-w' from code example shebang. Small wording improvements.
Author: mb
Index: perl.xml
===================================================================
RCS file: /home/cvs/doc-developer/en/content/contributing/code-style-guide/perl.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -2 -u -d -r1.4 -r1.5
--- perl.xml 21 Apr 2012 23:06:56 -0000 1.4
+++ perl.xml 16 Jan 2013 09:18:05 -0000 1.5
@@ -41,6 +41,6 @@
<title>Source Code Header and Charset</title>
<para>
- Attach the following header to each and every source file.
- Source files are saved in Charset UTF-8.
+ Attach the following header to every source file.
+ Source files are saved in UTF-8 charset.
</para>
<para>
@@ -48,5 +48,5 @@
# --
# (file name) - a short description what it does
-# Copyright (C) 2001-2012 OTRS AG, http://otrs.org/
+# Copyright (C) 2001-2013 OTRS AG, http://otrs.org/
# --
# $Id$
@@ -63,8 +63,8 @@
<para>
<programlisting format="linespecific"><![CDATA[
-#!/usr/bin/perl -w
+#!/usr/bin/perl
# --
# (file name) - a short description what it does
-# Copyright (C) 2001-2012 OTRS AG, http://otrs.org/
+# Copyright (C) 2001-2013 OTRS AG, http://otrs.org/
# --
# $Id$
@@ -122,7 +122,7 @@
<para>
<programlisting format="linespecific"><![CDATA[
- # -----------------------------#
- # here starts a special area
- # -----------------------------#
+ # -----------------------------------#
+ # here is the start of a special area
+ # -----------------------------------#
]]></programlisting>
</para>
@@ -132,5 +132,5 @@
<para>
<programlisting format="linespecific"><![CDATA[
- # --- customizing for bsi
+ # --- customizing for some project
]]></programlisting>
</para>
@@ -190,5 +190,5 @@
<title>Length of lines</title>
<para>
- Please see that a line of code is not longer then 100 charactars.
+ Make sure that a line of code is not longer than 100 charactars.
</para>
</section>
@@ -198,6 +198,6 @@
<title>Objects and their allocation</title>
<para>
- In OTRS many objects are available. But it is not allowed to use every object in each script.
- Please note the following definitions
+ In OTRS many objects are available. But you should not use every object in every file.
+ This is also because of the split between frontend and backend code.
</para>
<para>
@@ -229,5 +229,5 @@
</listitem>
<listitem>
- <para>don't use the Perl "require" function any more</para>
+ <para>don't use the Perl "require" function, use the MainObject</para>
</listitem>
</itemizedlist>
@@ -255,5 +255,5 @@
<para>
For regular expressions we always use the m// operator with curly braces as delimiters. We also use the modifiers x, m and s.
- The x modifiers allows you two comment your regex and use spaces to "group" logical groups.
+ The x modifiers allows you to comment your regex and use spaces to "group" logical groups.
</para>
<para>
@@ -270,5 +270,5 @@
</para>
<para>
- As the space has no longer a special meaning, you have to use a single character class to match a single space ( [ ]). If you want to match any whitespace you can use \s.
+ As the space no longer has a special meaning, you have to use a single character class to match a single space ( [ ]). If you want to match any whitespace you can use \s.
In the regex, the dot ('.') includes the newline (whereas in regex without s modifier the dot means 'everything but newline'). If you want to match anything but newline, you have to use the negated single character class ([^\n]).
---------------------------------------------------------------------
OTRS mailing list: cvs-log - Webpage: http://otrs.org/
Archive: http://lists.otrs.org/pipermail/cvs-log
To unsubscribe: http://lists.otrs.org/cgi-bin/listinfo/cvs-log