* [PATCH] mini-os: add a coding style file
@ 2017-11-09 12:10 Juergen Gross
2017-11-09 12:31 ` Wei Liu
0 siblings, 1 reply; 6+ messages in thread
From: Juergen Gross @ 2017-11-09 12:10 UTC (permalink / raw)
To: minios-devel, xen-devel; +Cc: Juergen Gross, samuel.thibault, wei.liu2
Since carving out Mini-OS from the Xen repository there hasn't been a
description of the preferred coding style. Copy the Xen CODING_STYLE
file.
Signed-off-by: Juergen Gross <jgross@suse.com>
---
CODING_STYLE | 109 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 109 insertions(+)
create mode 100644 CODING_STYLE
diff --git a/CODING_STYLE b/CODING_STYLE
new file mode 100644
index 0000000..539aa60
--- /dev/null
+++ b/CODING_STYLE
@@ -0,0 +1,109 @@
+Coding Style for Mini-OS
+========================
+
+Indentation
+-----------
+
+Indenting uses spaces, not tabs - in contrast to Linux. An indent
+level consists of four spaces. Code within blocks is indented by one
+extra indent level. The enclosing braces of a block are indented the
+same as the code _outside_ the block. e.g.
+
+void fun(void)
+{
+ /* One level of indent. */
+
+ {
+ /* A second level of indent. */
+ }
+}
+
+White space
+-----------
+
+Space characters are used to spread out logical statements, such as in
+the condition of an if or while. Spaces are placed between the
+keyword and the brackets surrounding the condition, between the
+brackets and the condition itself, and around binary operators (except
+the structure access operators, '.' and '->'). e.g.
+
+if ( (wibble & wombat) == 42 )
+{
+ ...
+
+There should be no trailing white space at the end of lines (including
+after the opening /* of a comment block).
+
+Line Length
+-----------
+
+Lines should be less than 80 characters in length. Long lines should
+be split at sensible places and the trailing portions indented.
+
+User visible strings (e.g., printk() messages) should not be split so
+they can searched for more easily.
+
+Bracing
+-------
+
+Braces ('{' and '}') are usually placed on a line of their own, except
+for the do/while loop. This is unlike the Linux coding style and
+unlike K&R. do/while loops are an exception. e.g.:
+
+if ( condition )
+{
+ /* Do stuff. */
+}
+else
+{
+ /* Other stuff. */
+}
+
+while ( condition )
+{
+ /* Do stuff. */
+}
+
+do {
+ /* Do stuff. */
+} while ( condition );
+
+etc.
+
+Braces should be omitted for blocks with a single statement. e.g.,
+
+if ( condition )
+ single_statement();
+
+Comments
+--------
+
+Only C style /* ... */ comments are to be used. C++ style // comments
+should not be used. Multi-word comments should begin with a capital
+letter. Comments containing a single sentence may end with a full
+stop; comments containing several sentences must have a full stop
+after each sentence.
+
+Multi-line comment blocks should start and end with comment markers on
+separate lines and each line should begin with a leading '*'.
+
+/*
+ * Example, multi-line comment block.
+ *
+ * Note beginning and end markers on separate lines and leading '*'.
+ */
+
+Emacs local variables
+---------------------
+
+A comment block containing local variables for emacs is permitted at
+the end of files. It should be:
+
+/*
+ * Local variables:
+ * mode: C
+ * c-file-style: "BSD"
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ */
--
2.12.3
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] mini-os: add a coding style file
2017-11-09 12:10 [PATCH] mini-os: add a coding style file Juergen Gross
@ 2017-11-09 12:31 ` Wei Liu
2017-11-09 12:35 ` Juergen Gross
0 siblings, 1 reply; 6+ messages in thread
From: Wei Liu @ 2017-11-09 12:31 UTC (permalink / raw)
To: Juergen Gross; +Cc: minios-devel, xen-devel, wei.liu2, samuel.thibault
On Thu, Nov 09, 2017 at 01:10:12PM +0100, Juergen Gross wrote:
> Since carving out Mini-OS from the Xen repository there hasn't been a
> description of the preferred coding style. Copy the Xen CODING_STYLE
> file.
>
I welcome such addition. I have no opinion in actual style used though.
I just want consistency. :-)
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] mini-os: add a coding style file
2017-11-09 12:31 ` Wei Liu
@ 2017-11-09 12:35 ` Juergen Gross
2017-11-09 12:45 ` Wei Liu
0 siblings, 1 reply; 6+ messages in thread
From: Juergen Gross @ 2017-11-09 12:35 UTC (permalink / raw)
To: Wei Liu; +Cc: minios-devel, xen-devel, samuel.thibault
On 09/11/17 13:31, Wei Liu wrote:
> On Thu, Nov 09, 2017 at 01:10:12PM +0100, Juergen Gross wrote:
>> Since carving out Mini-OS from the Xen repository there hasn't been a
>> description of the preferred coding style. Copy the Xen CODING_STYLE
>> file.
>>
>
> I welcome such addition. I have no opinion in actual style used though.
> I just want consistency. :-)
Is this an Ack?
Juergen
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] mini-os: add a coding style file
2017-11-09 12:35 ` Juergen Gross
@ 2017-11-09 12:45 ` Wei Liu
2018-02-12 10:59 ` [Minios-devel] " Juergen Gross
0 siblings, 1 reply; 6+ messages in thread
From: Wei Liu @ 2017-11-09 12:45 UTC (permalink / raw)
To: Juergen Gross; +Cc: minios-devel, xen-devel, Wei Liu, samuel.thibault
On Thu, Nov 09, 2017 at 01:35:49PM +0100, Juergen Gross wrote:
> On 09/11/17 13:31, Wei Liu wrote:
> > On Thu, Nov 09, 2017 at 01:10:12PM +0100, Juergen Gross wrote:
> >> Since carving out Mini-OS from the Xen repository there hasn't been a
> >> description of the preferred coding style. Copy the Xen CODING_STYLE
> >> file.
> >>
> >
> > I welcome such addition. I have no opinion in actual style used though.
> > I just want consistency. :-)
>
> Is this an Ack?
>
Yes.
Acked-by: Wei Liu <wei.liu2@citrix.com>
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [Minios-devel] [PATCH] mini-os: add a coding style file
2017-11-09 12:45 ` Wei Liu
@ 2018-02-12 10:59 ` Juergen Gross
2018-02-13 11:35 ` Wei Liu
0 siblings, 1 reply; 6+ messages in thread
From: Juergen Gross @ 2018-02-12 10:59 UTC (permalink / raw)
To: Wei Liu; +Cc: minios-devel, xen-devel, samuel.thibault
On 09/11/17 13:45, Wei Liu wrote:
> On Thu, Nov 09, 2017 at 01:35:49PM +0100, Juergen Gross wrote:
>> On 09/11/17 13:31, Wei Liu wrote:
>>> On Thu, Nov 09, 2017 at 01:10:12PM +0100, Juergen Gross wrote:
>>>> Since carving out Mini-OS from the Xen repository there hasn't been a
>>>> description of the preferred coding style. Copy the Xen CODING_STYLE
>>>> file.
>>>>
>>>
>>> I welcome such addition. I have no opinion in actual style used though.
>>> I just want consistency. :-)
>>
>> Is this an Ack?
>>
>
> Yes.
>
> Acked-by: Wei Liu <wei.liu2@citrix.com>
So this is pending for 3 months now...
Juergen
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [Minios-devel] [PATCH] mini-os: add a coding style file
2018-02-12 10:59 ` [Minios-devel] " Juergen Gross
@ 2018-02-13 11:35 ` Wei Liu
0 siblings, 0 replies; 6+ messages in thread
From: Wei Liu @ 2018-02-13 11:35 UTC (permalink / raw)
To: Juergen Gross; +Cc: minios-devel, xen-devel, Wei Liu, samuel.thibault
On Mon, Feb 12, 2018 at 11:59:23AM +0100, Juergen Gross wrote:
> On 09/11/17 13:45, Wei Liu wrote:
> > On Thu, Nov 09, 2017 at 01:35:49PM +0100, Juergen Gross wrote:
> >> On 09/11/17 13:31, Wei Liu wrote:
> >>> On Thu, Nov 09, 2017 at 01:10:12PM +0100, Juergen Gross wrote:
> >>>> Since carving out Mini-OS from the Xen repository there hasn't been a
> >>>> description of the preferred coding style. Copy the Xen CODING_STYLE
> >>>> file.
> >>>>
> >>>
> >>> I welcome such addition. I have no opinion in actual style used though.
> >>> I just want consistency. :-)
> >>
> >> Is this an Ack?
> >>
> >
> > Yes.
> >
> > Acked-by: Wei Liu <wei.liu2@citrix.com>
>
> So this is pending for 3 months now...
>
Oops, sorry. You know why I didn't get to this earlier. :-)
This and other pending patches will be committed shortly.
Wei.
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2018-02-13 11:35 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-11-09 12:10 [PATCH] mini-os: add a coding style file Juergen Gross
2017-11-09 12:31 ` Wei Liu
2017-11-09 12:35 ` Juergen Gross
2017-11-09 12:45 ` Wei Liu
2018-02-12 10:59 ` [Minios-devel] " Juergen Gross
2018-02-13 11:35 ` Wei Liu
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.