Linux-Trace-Devel Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] trace-cmd: Add CODING_STYLE and CONTRIBUTE documents
@ 2021-04-05 19:19 Steven Rostedt
  2021-04-06  8:18 ` Yordan Karadzhov
                   ` (2 more replies)
  0 siblings, 3 replies; 7+ messages in thread
From: Steven Rostedt @ 2021-04-05 19:19 UTC (permalink / raw)
  To: Linux Trace Devel; +Cc: Sameeruddin shaik

[
   Hi Sameer,
   I added you since you are the newest contributor, and would like to know
   if from your perspective, if these documents would have been helpful
   to you when you first started to contribute.
   Thanks!
]

From: "Steven Rostedt (VMware)" <rostedt@goodmis.org>

Add a CODING_STYLE document that describes the expected style of the code
as well as a CONTRIBUTE document that explains how a new comer can
contribute to the project.

Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
---
 CODING_STYLE | 179 +++++++++++++++++++++++++++++++++++++++++++++++++++
 CONTRIBUTE   |  80 +++++++++++++++++++++++
 2 files changed, 259 insertions(+)
 create mode 100644 CODING_STYLE
 create mode 100644 CONTRIBUTE

diff --git a/CODING_STYLE b/CODING_STYLE
new file mode 100644
index 00000000..6aff138e
--- /dev/null
+++ b/CODING_STYLE
@@ -0,0 +1,179 @@
+
+trace-cmd coding-style
+======================
+
+The coding style of trace-cmd and the tracing librariers (libtracefs and
+libtraceevent) are very similar to the Linux kernel coding style:
+
+  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/coding-style.rst
+
+Indentation
+===========
+
+Tabs are used for the start of indentation (the '\t' character), and should be
+set to 8 characters. Spaces may be used at the end for continued lines where
+having the start of text line up to braces in the previous line is not
+divisible by 8.
+
+Max line width
+==============
+
+This is a guide, as readability is more important than breaking lines up into a
+hard limit. Ideally, strings should never be broken up except for where a new
+line is added.
+
+	printf("This is a line that may continue for a very long string.\n"
+	       "This is another line, but after a new line\n");
+
+But line breaks should not be:
+
+	printf("This is a line that may continue for a very"
+	       "long string.\n This is another line,"
+	       "but after a new line\n");
+
+Not only is the above not as readable as the first version, it is not
+even equivalent, because it is missing spaces between the line breaks.
+For this reason, finish the string on the same line.
+
+Brackets and baces
+==================
+
+For all conditionals, the braces start on the same line:
+
+	if (cond) {
+	}
+
+And the ending brace is at the same indentation as the conditional.
+
+	while (cond) {
+	}
+
+	do {
+	} while (cond);
+
+	for (i = 0; i < 10; i++) {
+	}
+
+The same is true for structures:
+
+	struct my_struct {
+		int field;
+	};
+
+But for functions, the baces should start on the following line:
+
+	void my_function(void)
+	{
+	}
+
+
+Variable declarations
+=====================
+
+The order of variables that are declared, should first keep the same types
+together, but also should be ordered by their length such that the variables
+are ordered in an "upside-down Christmas tree" fashion where the length gets
+smaller.
+
+	int tracecmd_count_cpus(void)
+	{
+		static int once;
+		char buf[1024];
+		int cpus = 0;
+		char *pbuf;
+		size_t *pn;
+		FILE *fp;
+		size_t n;
+		int r;
+
+The above shows that the order is done by length, and in the above example it
+also shows that "int cpu = 0;" is not grouped next to "int r;". As this is more
+of a guideline and made to be more aesthetic to the eye of the reader, both the
+above and is acceptable as below.
+
+	int tracecmd_count_cpus(void)
+	{
+		static int once;
+		char buf[1024];
+		char *pbuf;
+		size_t *pn;
+		FILE *fp;
+		size_t n;
+		int cpus = 0;
+		int r;
+
+
+Unless variables are tightly related, it is expected that each variable be on
+its own line and not grouped by type. That is,
+
+		int r, cpus = 0;
+
+is to be discouraged, as the two variables are not related to each other.
+But if you had a bunch of counters:
+
+		int i, j, k;
+
+That would be fine, as the variables are all related as they are all for the
+same purpose (arbitrary counters). The same may go with pointers;
+
+
+	char *begin, *end;
+
+Comments
+========
+
+Comments will use the "/* */" format and the C++ "//" style is discouraged.
+If a comment is on one line, keep the "/*" and "*/" on the same line:
+
+	/* This is a single line comment. */
+
+If a comment spans more than one line, then have the "/*" on a separate line
+before the comment and the "*/" on a separate line at the end of the comment,
+and each line starts with a "*" where all the "*" line up with each other.
+
+	/*
+	 * This is a multi line comment, where all the '*'
+	 * will line up, and the text is on a separate line
+	 * as the start and end markers.
+	 */
+
+
+Function documentation
+======================
+
+All global functions (and especially any APIs) should have a function
+description in the form of "kernel doc":
+
+  https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html
+
+The form is:
+
+  /**
+   * function_name() - Brief description of function.
+   * @arg1: Describe the first argument.
+   * @arg2: Describe the second argument.
+   *        One can provide multiple line descriptions
+   *        for arguments.
+   *
+   * A longer description, with more discussion of the function function_name()
+   * that might be useful to those using or modifying it. Begins with an
+   * empty comment line, and may include additional embedded empty
+   * comment lines.
+   *
+   * The longer description may have multiple paragraphs.
+   *
+   * Context: Describes whether the function can sleep, what locks it takes,
+   *          releases, or expects to be held. It can extend over multiple
+   *          lines.
+   * Return: Describe the return value of function_name.
+   *
+   * The return value description can also have multiple paragraphs, and should
+   * be placed at the end of the comment block.
+   */
+
+General
+=======
+
+As stated, this is a guide and may not be strictly enforced. The goal is to
+have consistent and readable code. In general, try to have the coding style
+match the surrounding code.
diff --git a/CONTRIBUTE b/CONTRIBUTE
new file mode 100644
index 00000000..f03d00d8
--- /dev/null
+++ b/CONTRIBUTE
@@ -0,0 +1,80 @@
+If you like to become part of the community and submit patches, here's how
+to do so for trace-cmd.
+
+If you only want to report a bug, or suggest an enhancement, you may do
+so at:
+
+  https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark
+
+All development is done via a mailing list:
+
+   http://vger.kernel.org/vger-lists.html#linux-trace-devel
+
+Patches should be sent to linux-trace-devel@vger.kernel.org
+
+Start by cloning the official repository:
+
+  git clone git://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git
+
+Make your changes. When you are satisfied with them, commit them into git.
+Here's some helpful hints for your git commits.
+
+1) When making changes, please follow the coding style defined by the file
+   called CODING_STYLE in this directory.
+
+2) Every commit should only do one thing.
+   That is, if your work requires some cleaning up of code, do that
+   clean up as a separate commit and not with your functional changes.
+   Find ways to take "steps" in modifying code. If you can break up
+   your changes in a series of steps, do so.
+
+3) The commit log should start with a title. Like the below
+
+      trace-cmd: Add CONTRIBUTE file
+
+   Even though this repo is for trace-cmd, start the topic with
+   "trace-cmd:" because the commits will end up as patches to a mailing
+   list that handles other tracing repos, differentiating them with the subject
+   is useful. You can be more specific as well. If the change only affects the
+   "record" command, you may start the title with "trace-cmd record:".
+
+4) The body of the commit (with a blank line from the title), should be self
+   contained, and explain why you are making the change. The title should hold
+   the "what" is changing, but the body contains the rationale for the change.
+   It should be a stand alone, and not state things like "See the next patch",
+   because when it is in git history, there's no knowing what the next patch
+   is.  You can make statements like "This is needed for a <future-feature>
+   that will come later". Where "<future-feature>" is something that you are
+   working on and the current commit is one of the steps required to get there.
+
+5) Add your Developer Certificate of Origin (DCO) at the bottom of the commit
+   log. That is "Signed-off-by: Full Name <email>" where your full name is your
+   real name (no pseudonyms). Optionally, if you are making the change on
+   behalf of your company, you may also add your company name, if you are not
+   using your company's email. "Signed-off-by: Full Name (Company) <email>".
+   Please note, the DCO is your statement that you have the legal right to
+   make these changes for the project you are submitting to.
+
+Finally, you can use the git "send-email" functionality:
+
+  git --send-email --from='<your-email> --to='linux-trace-devel@vger.kernel.org' HEAD~1..HEAD
+
+If you are sending one patch, if you are adding more than one patch, also include
+a cover letter:
+
+  git --send-email --cover-letter --annotate --from='<your-email> --to='linux-trace-devel@vger.kernel.org' <first-commit>~1..HEAD
+
+If you receive feedback on your patches, and plan on sending another version,
+please use the '-v' option to mark your patches that they are a new version.
+For example, if you add "-v2" to the above commands, instead of having:
+"[PATCH]" in the subject, it will have "[PATCH v2]", letting the reviewers know
+that this is a new version. If you send another version, use "-v3" and so on.
+
+For more information about git --send-email:
+
+  https://git-scm.com/docs/git-send-email
+
+To keep track of the status of patches that have been submitted, check out:
+
+  https://patchwork.kernel.org/project/linux-trace-devel/list/
+
-- 
2.29.2


^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] trace-cmd: Add CODING_STYLE and CONTRIBUTE documents
  2021-04-05 19:19 [PATCH] trace-cmd: Add CODING_STYLE and CONTRIBUTE documents Steven Rostedt
@ 2021-04-06  8:18 ` Yordan Karadzhov
  2021-04-06 12:39   ` Steven Rostedt
  2021-04-06  9:37 ` Tzvetomir Stoyanov
  2021-04-07  0:58 ` sameeruddin shaik
  2 siblings, 1 reply; 7+ messages in thread
From: Yordan Karadzhov @ 2021-04-06  8:18 UTC (permalink / raw)
  To: Steven Rostedt, Linux Trace Devel; +Cc: Sameeruddin shaik

Hi Steven,

On 5.04.21 г. 22:19, Steven Rostedt wrote:
> Unless variables are tightly related, it is expected that each variable be on
> +its own line and not grouped by type. That is,
> +
> +		int r, cpus = 0;
> +
> +is to be discouraged, as the two variables are not related to each other.
> +But if you had a bunch of counters:
> +
> +		int i, j, k;
> +
> +That would be fine, as the variables are all related as they are all for the
> +same purpose (arbitrary counters). The same may go with pointers;
> +
> +
> +	char *begin, *end;
> +

Maybe we should include an explanation what to do in cases like this:

         struct instance_wrapper *iw, **iw_ptr;


Let's say, the two are closely related in the code of the function, 
however technically speaking the types are different. Is it OK to have 
both on the same line?

Thanks!

Yordan



^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] trace-cmd: Add CODING_STYLE and CONTRIBUTE documents
  2021-04-05 19:19 [PATCH] trace-cmd: Add CODING_STYLE and CONTRIBUTE documents Steven Rostedt
  2021-04-06  8:18 ` Yordan Karadzhov
@ 2021-04-06  9:37 ` Tzvetomir Stoyanov
  2021-04-06 12:47   ` Steven Rostedt
  2021-04-07  0:58 ` sameeruddin shaik
  2 siblings, 1 reply; 7+ messages in thread
From: Tzvetomir Stoyanov @ 2021-04-06  9:37 UTC (permalink / raw)
  To: Steven Rostedt; +Cc: Linux Trace Devel, Sameeruddin shaik

Hi Steven,
I have a few suggestions:

On Tue, Apr 6, 2021 at 10:41 AM Steven Rostedt <rostedt@goodmis.org> wrote:
>
> [
>    Hi Sameer,
>    I added you since you are the newest contributor, and would like to know
>    if from your perspective, if these documents would have been helpful
>    to you when you first started to contribute.
>    Thanks!
> ]
>
> From: "Steven Rostedt (VMware)" <rostedt@goodmis.org>
>
> Add a CODING_STYLE document that describes the expected style of the code
> as well as a CONTRIBUTE document that explains how a new comer can
> contribute to the project.
>
> Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
> ---
>  CODING_STYLE | 179 +++++++++++++++++++++++++++++++++++++++++++++++++++
>  CONTRIBUTE   |  80 +++++++++++++++++++++++
>  2 files changed, 259 insertions(+)
>  create mode 100644 CODING_STYLE
>  create mode 100644 CONTRIBUTE
>
> diff --git a/CODING_STYLE b/CODING_STYLE
> new file mode 100644
> index 00000000..6aff138e
> --- /dev/null
> +++ b/CODING_STYLE
> @@ -0,0 +1,179 @@
> +
> +trace-cmd coding-style
> +======================
> +
> +The coding style of trace-cmd and the tracing librariers (libtracefs and
> +libtraceevent) are very similar to the Linux kernel coding style:
> +
> +  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/coding-style.rst
> +
> +Indentation
> +===========
> +
> +Tabs are used for the start of indentation (the '\t' character), and should be
> +set to 8 characters. Spaces may be used at the end for continued lines where
> +having the start of text line up to braces in the previous line is not
> +divisible by 8.
> +
> +Max line width
> +==============

The desirable max line width should be written here, should we stick
with the 100 char limit, recently introduced in the Linux kernel ?

> +
> +This is a guide, as readability is more important than breaking lines up into a
> +hard limit. Ideally, strings should never be broken up except for where a new
> +line is added.
> +
> +       printf("This is a line that may continue for a very long string.\n"
> +              "This is another line, but after a new line\n");
> +
> +But line breaks should not be:
> +
> +       printf("This is a line that may continue for a very"
> +              "long string.\n This is another line,"
> +              "but after a new line\n");
> +
> +Not only is the above not as readable as the first version, it is not
> +even equivalent, because it is missing spaces between the line breaks.
> +For this reason, finish the string on the same line.
> +
> +Brackets and baces

a typo, should be "braces".

> +==================
> +
> +For all conditionals, the braces start on the same line:
> +
> +       if (cond) {
> +       }

That extra space before the opening brace should be mentioned in this
paragraph. As this is something usual for the Linux kernel developers,
I think it is not widely used by user space C developers.

> +
> +And the ending brace is at the same indentation as the conditional.
> +
> +       while (cond) {
> +       }
> +
> +       do {
> +       } while (cond);
> +
> +       for (i = 0; i < 10; i++) {
> +       }
> +
> +The same is true for structures:
> +
> +       struct my_struct {
> +               int field;
> +       };
> +
> +But for functions, the baces should start on the following line:
> +
> +       void my_function(void)
> +       {
> +       }
> +
> +
> +Variable declarations
> +=====================
> +
> +The order of variables that are declared, should first keep the same types
> +together, but also should be ordered by their length such that the variables
> +are ordered in an "upside-down Christmas tree" fashion where the length gets
> +smaller.
> +
> +       int tracecmd_count_cpus(void)
> +       {
> +               static int once;
> +               char buf[1024];
> +               int cpus = 0;
> +               char *pbuf;
> +               size_t *pn;
> +               FILE *fp;
> +               size_t n;
> +               int r;
> +
> +The above shows that the order is done by length, and in the above example it
> +also shows that "int cpu = 0;" is not grouped next to "int r;". As this is more
> +of a guideline and made to be more aesthetic to the eye of the reader, both the
> +above and is acceptable as below.
> +
> +       int tracecmd_count_cpus(void)
> +       {
> +               static int once;
> +               char buf[1024];
> +               char *pbuf;
> +               size_t *pn;
> +               FILE *fp;
> +               size_t n;
> +               int cpus = 0;
> +               int r;
> +
> +
> +Unless variables are tightly related, it is expected that each variable be on
> +its own line and not grouped by type. That is,
> +
> +               int r, cpus = 0;
> +
> +is to be discouraged, as the two variables are not related to each other.
> +But if you had a bunch of counters:
> +
> +               int i, j, k;
> +
> +That would be fine, as the variables are all related as they are all for the
> +same purpose (arbitrary counters). The same may go with pointers;
> +
> +
> +       char *begin, *end;
> +

One extra paragraph for arranging the members of a struct will be very
useful. I still wonder sometimes how to arrange them so the memory
will be used in a most optimal way.

> +Comments
> +========
> +
> +Comments will use the "/* */" format and the C++ "//" style is discouraged.
> +If a comment is on one line, keep the "/*" and "*/" on the same line:
> +
> +       /* This is a single line comment. */
> +
> +If a comment spans more than one line, then have the "/*" on a separate line
> +before the comment and the "*/" on a separate line at the end of the comment,
> +and each line starts with a "*" where all the "*" line up with each other.
> +
> +       /*
> +        * This is a multi line comment, where all the '*'
> +        * will line up, and the text is on a separate line
> +        * as the start and end markers.
> +        */
> +
> +
> +Function documentation
> +======================
> +
> +All global functions (and especially any APIs) should have a function
> +description in the form of "kernel doc":
> +
> +  https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html
> +
> +The form is:
> +
> +  /**
> +   * function_name() - Brief description of function.
> +   * @arg1: Describe the first argument.
> +   * @arg2: Describe the second argument.
> +   *        One can provide multiple line descriptions
> +   *        for arguments.
> +   *
> +   * A longer description, with more discussion of the function function_name()
> +   * that might be useful to those using or modifying it. Begins with an
> +   * empty comment line, and may include additional embedded empty
> +   * comment lines.
> +   *
> +   * The longer description may have multiple paragraphs.
> +   *
> +   * Context: Describes whether the function can sleep, what locks it takes,
> +   *          releases, or expects to be held. It can extend over multiple
> +   *          lines.
> +   * Return: Describe the return value of function_name.
> +   *
> +   * The return value description can also have multiple paragraphs, and should
> +   * be placed at the end of the comment block.
> +   */
> +
> +General
> +=======
> +
> +As stated, this is a guide and may not be strictly enforced. The goal is to
> +have consistent and readable code. In general, try to have the coding style
> +match the surrounding code.

I agree with Sameer, we should encourage people to use the
checkpatch.pl script from the kernel tree, before submitting the
patch. I find this script very useful, should be mentioned here or in
the CONTRIBUTE file.

[..]


-- 
Tzvetomir (Ceco) Stoyanov
VMware Open Source Technology Center

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] trace-cmd: Add CODING_STYLE and CONTRIBUTE documents
  2021-04-07  0:58 ` sameeruddin shaik
@ 2021-04-06 12:36   ` Steven Rostedt
  0 siblings, 0 replies; 7+ messages in thread
From: Steven Rostedt @ 2021-04-06 12:36 UTC (permalink / raw)
  To: sameeruddin shaik; +Cc: Linux Trace Devel

On Wed, 7 Apr 2021 06:28:35 +0530
sameeruddin shaik <sameeruddin.shaik8@gmail.com> wrote:

> > +Finally, you can use the git "send-email" functionality:
> > +
> > +  git --send-email --from='<your-email> --to='linux-trace-devel@vger.kernel.org' HEAD~1..HEAD  
> I think, we should add a line about "checking the patch using the 
> checkpatch script, before sending the email", what you say?

I'll add that, although I will say to think of checkpatch as more of a
guide and not a requirement. I find there's a lot of checkpatch fixes
that cause the code to be less readable. But I agree that it is useful for
someone just entering the project.

> 
> Another suggestion is,
> 
> we should document about, how to apply the mailing list patches, which 
> are not yet mainlined. people can search in the internet, but different 
> forums will give different approaches.

And I can give different approaches ;-)  The approach I gave to you with
patchwork may not be the best either. If I do add something here, it will
to use a new tool called "b4".

For example, you can apply this patch with:

 $ b4 am 20210405151959.1d6901b2@gandalf.local.home

Where I used the Message-ID of my email. It also works with series.

Anyway, thanks for the input. This was the reason I included you on this
patch.

-- Steve

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] trace-cmd: Add CODING_STYLE and CONTRIBUTE documents
  2021-04-06  8:18 ` Yordan Karadzhov
@ 2021-04-06 12:39   ` Steven Rostedt
  0 siblings, 0 replies; 7+ messages in thread
From: Steven Rostedt @ 2021-04-06 12:39 UTC (permalink / raw)
  To: Yordan Karadzhov; +Cc: Linux Trace Devel, Sameeruddin shaik

On Tue, 6 Apr 2021 11:18:07 +0300
Yordan Karadzhov <y.karadz@gmail.com> wrote:

> Maybe we should include an explanation what to do in cases like this:
> 
>          struct instance_wrapper *iw, **iw_ptr;
> 
> 
> Let's say, the two are closely related in the code of the function, 
> however technically speaking the types are different. Is it OK to have 
> both on the same line?

That's one of the cases where I would say it's an exception and not a rule.
Remember this document is a guide not a requirement as I state at the end.
I wouldn't include the above, as it's not common, and it really is a case
by case situation on how to do that, so it is out of scope for this
document.

-- Steve

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] trace-cmd: Add CODING_STYLE and CONTRIBUTE documents
  2021-04-06  9:37 ` Tzvetomir Stoyanov
@ 2021-04-06 12:47   ` Steven Rostedt
  0 siblings, 0 replies; 7+ messages in thread
From: Steven Rostedt @ 2021-04-06 12:47 UTC (permalink / raw)
  To: Tzvetomir Stoyanov; +Cc: Linux Trace Devel, Sameeruddin shaik

On Tue, 6 Apr 2021 12:37:28 +0300
Tzvetomir Stoyanov <tz.stoyanov@gmail.com> wrote:

> > +
> > +Max line width
> > +==============  
> 
> The desirable max line width should be written here, should we stick
> with the 100 char limit, recently introduced in the Linux kernel ?

Fair point. I actually thought I did mention it. Probably got distracted
and forgot about it.

> 
> > +
> > +This is a guide, as readability is more important than breaking lines up into a
> > +hard limit. Ideally, strings should never be broken up except for where a new
> > +line is added.
> > +
> > +       printf("This is a line that may continue for a very long string.\n"
> > +              "This is another line, but after a new line\n");
> > +
> > +But line breaks should not be:
> > +
> > +       printf("This is a line that may continue for a very"
> > +              "long string.\n This is another line,"
> > +              "but after a new line\n");
> > +
> > +Not only is the above not as readable as the first version, it is not
> > +even equivalent, because it is missing spaces between the line breaks.
> > +For this reason, finish the string on the same line.
> > +
> > +Brackets and baces  
> 
> a typo, should be "braces".

Yep.

> 
> > +==================
> > +
> > +For all conditionals, the braces start on the same line:
> > +
> > +       if (cond) {
> > +       }  
> 
> That extra space before the opening brace should be mentioned in this
> paragraph. As this is something usual for the Linux kernel developers,
> I think it is not widely used by user space C developers.

Ah, like the Linux kernel document that I link to, there's a section alone
on spaces. I left it out thinking that people could read that document, but
perhaps I should add the "Spaces" section as well.

I also forgot to mention when not to use braces:

	if (x)
		y = x;
	else
		y = 1;

	for (i = 0; i < 10; i++)
		foo(i);

Is fine to leave off.

But if there's more than one line, even if it C still allows it, then it
must have braces. And the else part must also match the if part.

 Do not do:

	if (!x)
		for (i = 0; i < 10; i++)
			foo(i);
	else
		foo(x);


 Should be:

	if (!x) {
		for (i = 0; i < 10; i++)
			foo(i);
	} else {
		foo(x);
	}



> 
> > +
> > +And the ending brace is at the same indentation as the conditional.
> > +
> > +       while (cond) {
> > +       }
> > +
> > +       do {
> > +       } while (cond);
> > +
> > +       for (i = 0; i < 10; i++) {
> > +       }
> > +
> > +The same is true for structures:
> > +
> > +       struct my_struct {
> > +               int field;
> > +       };
> > +
> > +But for functions, the baces should start on the following line:
> > +
> > +       void my_function(void)
> > +       {
> > +       }
> > +
> > +
> > +Variable declarations
> > +=====================
> > +
> > +The order of variables that are declared, should first keep the same types
> > +together, but also should be ordered by their length such that the variables
> > +are ordered in an "upside-down Christmas tree" fashion where the length gets
> > +smaller.
> > +
> > +       int tracecmd_count_cpus(void)
> > +       {
> > +               static int once;
> > +               char buf[1024];
> > +               int cpus = 0;
> > +               char *pbuf;
> > +               size_t *pn;
> > +               FILE *fp;
> > +               size_t n;
> > +               int r;
> > +
> > +The above shows that the order is done by length, and in the above example it
> > +also shows that "int cpu = 0;" is not grouped next to "int r;". As this is more
> > +of a guideline and made to be more aesthetic to the eye of the reader, both the
> > +above and is acceptable as below.
> > +
> > +       int tracecmd_count_cpus(void)
> > +       {
> > +               static int once;
> > +               char buf[1024];
> > +               char *pbuf;
> > +               size_t *pn;
> > +               FILE *fp;
> > +               size_t n;
> > +               int cpus = 0;
> > +               int r;
> > +
> > +
> > +Unless variables are tightly related, it is expected that each variable be on
> > +its own line and not grouped by type. That is,
> > +
> > +               int r, cpus = 0;
> > +
> > +is to be discouraged, as the two variables are not related to each other.
> > +But if you had a bunch of counters:
> > +
> > +               int i, j, k;
> > +
> > +That would be fine, as the variables are all related as they are all for the
> > +same purpose (arbitrary counters). The same may go with pointers;
> > +
> > +
> > +       char *begin, *end;
> > +  
> 
> One extra paragraph for arranging the members of a struct will be very
> useful. I still wonder sometimes how to arrange them so the memory
> will be used in a most optimal way.

Although this isn't coding style, its actual programming. But perhaps we
can add a section on that. At least mention using tabs for fields.

	struct {
		int		x;
		int		y;
		unsigned long	z;
	};

> 
> > +Comments
> > +========
> > +
> > +Comments will use the "/* */" format and the C++ "//" style is discouraged.
> > +If a comment is on one line, keep the "/*" and "*/" on the same line:
> > +
> > +       /* This is a single line comment. */
> > +
> > +If a comment spans more than one line, then have the "/*" on a separate line
> > +before the comment and the "*/" on a separate line at the end of the comment,
> > +and each line starts with a "*" where all the "*" line up with each other.
> > +
> > +       /*
> > +        * This is a multi line comment, where all the '*'
> > +        * will line up, and the text is on a separate line
> > +        * as the start and end markers.
> > +        */
> > +
> > +
> > +Function documentation
> > +======================
> > +
> > +All global functions (and especially any APIs) should have a function
> > +description in the form of "kernel doc":
> > +
> > +  https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html
> > +
> > +The form is:
> > +
> > +  /**
> > +   * function_name() - Brief description of function.
> > +   * @arg1: Describe the first argument.
> > +   * @arg2: Describe the second argument.
> > +   *        One can provide multiple line descriptions
> > +   *        for arguments.
> > +   *
> > +   * A longer description, with more discussion of the function function_name()
> > +   * that might be useful to those using or modifying it. Begins with an
> > +   * empty comment line, and may include additional embedded empty
> > +   * comment lines.
> > +   *
> > +   * The longer description may have multiple paragraphs.
> > +   *
> > +   * Context: Describes whether the function can sleep, what locks it takes,
> > +   *          releases, or expects to be held. It can extend over multiple
> > +   *          lines.
> > +   * Return: Describe the return value of function_name.
> > +   *
> > +   * The return value description can also have multiple paragraphs, and should
> > +   * be placed at the end of the comment block.
> > +   */
> > +
> > +General
> > +=======
> > +
> > +As stated, this is a guide and may not be strictly enforced. The goal is to
> > +have consistent and readable code. In general, try to have the coding style
> > +match the surrounding code.  
> 
> I agree with Sameer, we should encourage people to use the
> checkpatch.pl script from the kernel tree, before submitting the
> patch. I find this script very useful, should be mentioned here or in
> the CONTRIBUTE file.

I can mention it here, but as I told Sameer, think of both this guide and
checkpatch as just a guide, and not hard requirements. If the fixes from
checkpatch make the code look uglier, it is probably wrong ;-)

-- Steve


^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] trace-cmd: Add CODING_STYLE and CONTRIBUTE documents
  2021-04-05 19:19 [PATCH] trace-cmd: Add CODING_STYLE and CONTRIBUTE documents Steven Rostedt
  2021-04-06  8:18 ` Yordan Karadzhov
  2021-04-06  9:37 ` Tzvetomir Stoyanov
@ 2021-04-07  0:58 ` sameeruddin shaik
  2021-04-06 12:36   ` Steven Rostedt
  2 siblings, 1 reply; 7+ messages in thread
From: sameeruddin shaik @ 2021-04-07  0:58 UTC (permalink / raw)
  To: Steven Rostedt, Linux Trace Devel

hi steve,

On 06/04/21 12:49 am, Steven Rostedt wrote:
> [
>     Hi Sameer,
>     I added you since you are the newest contributor, and would like to know
>     if from your perspective, if these documents would have been helpful
>     to you when you first started to contribute.
>     Thanks!
> ]
>
> From: "Steven Rostedt (VMware)" <rostedt@goodmis.org>
>
> Add a CODING_STYLE document that describes the expected style of the code
> as well as a CONTRIBUTE document that explains how a new comer can
> contribute to the project.
>
> Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
> ---
>   CODING_STYLE | 179 +++++++++++++++++++++++++++++++++++++++++++++++++++
>   CONTRIBUTE   |  80 +++++++++++++++++++++++
>   2 files changed, 259 insertions(+)
>   create mode 100644 CODING_STYLE
>   create mode 100644 CONTRIBUTE
>
> diff --git a/CODING_STYLE b/CODING_STYLE
> new file mode 100644
> index 00000000..6aff138e
> --- /dev/null
> +++ b/CODING_STYLE
> @@ -0,0 +1,179 @@
> +
> +trace-cmd coding-style
> +======================
> +
> +The coding style of trace-cmd and the tracing librariers (libtracefs and
> +libtraceevent) are very similar to the Linux kernel coding style:
> +
> +  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/coding-style.rst
> +
> +Indentation
> +===========
> +
> +Tabs are used for the start of indentation (the '\t' character), and should be
> +set to 8 characters. Spaces may be used at the end for continued lines where
> +having the start of text line up to braces in the previous line is not
> +divisible by 8.
> +
> +Max line width
> +==============
> +
> +This is a guide, as readability is more important than breaking lines up into a
> +hard limit. Ideally, strings should never be broken up except for where a new
> +line is added.
> +
> +	printf("This is a line that may continue for a very long string.\n"
> +	       "This is another line, but after a new line\n");
> +
> +But line breaks should not be:
> +
> +	printf("This is a line that may continue for a very"
> +	       "long string.\n This is another line,"
> +	       "but after a new line\n");
> +
> +Not only is the above not as readable as the first version, it is not
> +even equivalent, because it is missing spaces between the line breaks.
> +For this reason, finish the string on the same line.
> +
> +Brackets and baces
> +==================
> +
> +For all conditionals, the braces start on the same line:
> +
> +	if (cond) {
> +	}
> +
> +And the ending brace is at the same indentation as the conditional.
> +
> +	while (cond) {
> +	}
> +
> +	do {
> +	} while (cond);
> +
> +	for (i = 0; i < 10; i++) {
> +	}
> +
> +The same is true for structures:
> +
> +	struct my_struct {
> +		int field;
> +	};
> +
> +But for functions, the baces should start on the following line:
> +
> +	void my_function(void)
> +	{
> +	}
> +
> +
> +Variable declarations
> +=====================
> +
> +The order of variables that are declared, should first keep the same types
> +together, but also should be ordered by their length such that the variables
> +are ordered in an "upside-down Christmas tree" fashion where the length gets
> +smaller.
> +
> +	int tracecmd_count_cpus(void)
> +	{
> +		static int once;
> +		char buf[1024];
> +		int cpus = 0;
> +		char *pbuf;
> +		size_t *pn;
> +		FILE *fp;
> +		size_t n;
> +		int r;
> +
> +The above shows that the order is done by length, and in the above example it
> +also shows that "int cpu = 0;" is not grouped next to "int r;". As this is more
> +of a guideline and made to be more aesthetic to the eye of the reader, both the
> +above and is acceptable as below.
> +
> +	int tracecmd_count_cpus(void)
> +	{
> +		static int once;
> +		char buf[1024];
> +		char *pbuf;
> +		size_t *pn;
> +		FILE *fp;
> +		size_t n;
> +		int cpus = 0;
> +		int r;
> +
> +
> +Unless variables are tightly related, it is expected that each variable be on
> +its own line and not grouped by type. That is,
> +
> +		int r, cpus = 0;
> +
> +is to be discouraged, as the two variables are not related to each other.
> +But if you had a bunch of counters:
> +
> +		int i, j, k;
> +
> +That would be fine, as the variables are all related as they are all for the
> +same purpose (arbitrary counters). The same may go with pointers;
> +
> +
> +	char *begin, *end;
> +
> +Comments
> +========
> +
> +Comments will use the "/* */" format and the C++ "//" style is discouraged.
> +If a comment is on one line, keep the "/*" and "*/" on the same line:
> +
> +	/* This is a single line comment. */
> +
> +If a comment spans more than one line, then have the "/*" on a separate line
> +before the comment and the "*/" on a separate line at the end of the comment,
> +and each line starts with a "*" where all the "*" line up with each other.
> +
> +	/*
> +	 * This is a multi line comment, where all the '*'
> +	 * will line up, and the text is on a separate line
> +	 * as the start and end markers.
> +	 */
> +
> +
> +Function documentation
> +======================
> +
> +All global functions (and especially any APIs) should have a function
> +description in the form of "kernel doc":
> +
> +  https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html
> +
> +The form is:
> +
> +  /**
> +   * function_name() - Brief description of function.
> +   * @arg1: Describe the first argument.
> +   * @arg2: Describe the second argument.
> +   *        One can provide multiple line descriptions
> +   *        for arguments.
> +   *
> +   * A longer description, with more discussion of the function function_name()
> +   * that might be useful to those using or modifying it. Begins with an
> +   * empty comment line, and may include additional embedded empty
> +   * comment lines.
> +   *
> +   * The longer description may have multiple paragraphs.
> +   *
> +   * Context: Describes whether the function can sleep, what locks it takes,
> +   *          releases, or expects to be held. It can extend over multiple
> +   *          lines.
> +   * Return: Describe the return value of function_name.
> +   *
> +   * The return value description can also have multiple paragraphs, and should
> +   * be placed at the end of the comment block.
> +   */
> +
> +General
> +=======
> +
> +As stated, this is a guide and may not be strictly enforced. The goal is to
> +have consistent and readable code. In general, try to have the coding style
> +match the surrounding code.
> diff --git a/CONTRIBUTE b/CONTRIBUTE
> new file mode 100644
> index 00000000..f03d00d8
> --- /dev/null
> +++ b/CONTRIBUTE
> @@ -0,0 +1,80 @@
> +If you like to become part of the community and submit patches, here's how
> +to do so for trace-cmd.
> +
> +If you only want to report a bug, or suggest an enhancement, you may do
> +so at:
> +
> +  https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark
> +
> +All development is done via a mailing list:
> +
> +   http://vger.kernel.org/vger-lists.html#linux-trace-devel
> +
> +Patches should be sent to linux-trace-devel@vger.kernel.org
> +
> +Start by cloning the official repository:
> +
> +  git clone git://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git
> +
> +Make your changes. When you are satisfied with them, commit them into git.
> +Here's some helpful hints for your git commits.
> +
> +1) When making changes, please follow the coding style defined by the file
> +   called CODING_STYLE in this directory.
> +
> +2) Every commit should only do one thing.
> +   That is, if your work requires some cleaning up of code, do that
> +   clean up as a separate commit and not with your functional changes.
> +   Find ways to take "steps" in modifying code. If you can break up
> +   your changes in a series of steps, do so.
> +
> +3) The commit log should start with a title. Like the below
> +
> +      trace-cmd: Add CONTRIBUTE file
> +
> +   Even though this repo is for trace-cmd, start the topic with
> +   "trace-cmd:" because the commits will end up as patches to a mailing
> +   list that handles other tracing repos, differentiating them with the subject
> +   is useful. You can be more specific as well. If the change only affects the
> +   "record" command, you may start the title with "trace-cmd record:".
> +
> +4) The body of the commit (with a blank line from the title), should be self
> +   contained, and explain why you are making the change. The title should hold
> +   the "what" is changing, but the body contains the rationale for the change.
> +   It should be a stand alone, and not state things like "See the next patch",
> +   because when it is in git history, there's no knowing what the next patch
> +   is.  You can make statements like "This is needed for a <future-feature>
> +   that will come later". Where "<future-feature>" is something that you are
> +   working on and the current commit is one of the steps required to get there.
> +
> +5) Add your Developer Certificate of Origin (DCO) at the bottom of the commit
> +   log. That is "Signed-off-by: Full Name <email>" where your full name is your
> +   real name (no pseudonyms). Optionally, if you are making the change on
> +   behalf of your company, you may also add your company name, if you are not
> +   using your company's email. "Signed-off-by: Full Name (Company) <email>".
> +   Please note, the DCO is your statement that you have the legal right to
> +   make these changes for the project you are submitting to.
> +
> +Finally, you can use the git "send-email" functionality:
> +
> +  git --send-email --from='<your-email> --to='linux-trace-devel@vger.kernel.org' HEAD~1..HEAD
I think, we should add a line about "checking the patch using the 
checkpatch script, before sending the email", what you say?

Another suggestion is,

we should document about, how to apply the mailing list patches, which 
are not yet mainlined. people can search in the internet, but different 
forums will give different approaches.

> +
> +If you are sending one patch, if you are adding more than one patch, also include
> +a cover letter:
> +
> +  git --send-email --cover-letter --annotate --from='<your-email> --to='linux-trace-devel@vger.kernel.org' <first-commit>~1..HEAD
> +
> +If you receive feedback on your patches, and plan on sending another version,
> +please use the '-v' option to mark your patches that they are a new version.
> +For example, if you add "-v2" to the above commands, instead of having:
> +"[PATCH]" in the subject, it will have "[PATCH v2]", letting the reviewers know
> +that this is a new version. If you send another version, use "-v3" and so on.
> +
> +For more information about git --send-email:
> +
> +  https://git-scm.com/docs/git-send-email
> +
> +To keep track of the status of patches that have been submitted, check out:
> +
> +  https://patchwork.kernel.org/project/linux-trace-devel/list/
> +


^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, back to index

Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-05 19:19 [PATCH] trace-cmd: Add CODING_STYLE and CONTRIBUTE documents Steven Rostedt
2021-04-06  8:18 ` Yordan Karadzhov
2021-04-06 12:39   ` Steven Rostedt
2021-04-06  9:37 ` Tzvetomir Stoyanov
2021-04-06 12:47   ` Steven Rostedt
2021-04-07  0:58 ` sameeruddin shaik
2021-04-06 12:36   ` Steven Rostedt

Linux-Trace-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-trace-devel/0 linux-trace-devel/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-trace-devel linux-trace-devel/ https://lore.kernel.org/linux-trace-devel \
		linux-trace-devel@vger.kernel.org
	public-inbox-index linux-trace-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-trace-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git