public inbox for ltp@lists.linux.it
 help / color / mirror / Atom feed
From: Cyril Hrubis <chrubis@suse.cz>
To: Cui Bixuan <cuibixuan@huawei.com>
Cc: ltp-list@lists.sourceforge.net
Subject: Re: [LTP] [PATCH v3 1/2] testcases/lib/test.sh: Added ROD_SILENT() and ROD()
Date: Thu, 30 Apr 2015 09:51:08 +0200	[thread overview]
Message-ID: <20150430075108.GC479@rei.suse.de> (raw)
In-Reply-To: <55417DFD.1040207@huawei.com>

Hi!
> > I update the repository and got the documentation. It looks good, and
> > thank you very much.
> > 
> Maybe you can write the descriptive file such as tar/00_Descriptions.txt,
> but I don't know if it's necessary.

My opinion is that the less documentation is needed the better. Which
means that one should write clean code and if possible avoid cryptic
constructs and comment only parts that needs to be.

In LTP we usually add a short description of the testcase in a comment
at the start of the test source. Looking at the tar testcase, I would be
better to move the description to the comment at the start of the
tar_tests.sh. Having it in separate file is not good idea.

-- 
Cyril Hrubis
chrubis@suse.cz

------------------------------------------------------------------------------
One dashboard for servers and applications across Physical-Virtual-Cloud 
Widest out-of-the-box monitoring support with 50+ applications
Performance metrics, stats and reports that give you Actionable Insights
Deep dive visibility with transaction tracing using APM Insight.
http://ad.doubleclick.net/ddm/clk/290420510;117567292;y
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list

  parent reply	other threads:[~2015-04-30  7:51 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-04-02 10:35 [LTP] [RFC PATCH] commands/du: Added new testcase to test du(1) command Zeng Linggang
2015-04-02 11:59 ` Cyril Hrubis
     [not found]   ` <1429010688.7190.24.camel@G08JYZSD130126.localdomain>
2015-04-22 12:47     ` [LTP] [RFC PATCH v2 1/2] testcases/lib/test.sh: added SAFE_CALL*() Cyril Hrubis
     [not found]       ` <1429755598.2416.14.camel@G08JYZSD130126.localdomain>
2015-04-23 10:27         ` Cyril Hrubis
     [not found]   ` <1429010747.7190.25.camel@G08JYZSD130126.localdomain>
2015-04-22 12:58     ` [LTP] [RFC PATCH v2 2/2] commands/du: Added new testcase to test du(1) command Cyril Hrubis
     [not found]       ` <1429784431-14017-1-git-send-email-zenglg.jy@cn.fujitsu.com>
2015-04-28 14:10         ` [LTP] [PATCH v3 1/2] testcases/lib/test.sh: Added ROD_SILENT() and ROD() Cyril Hrubis
     [not found]           ` <1430270054.7745.11.camel@G08JYZSD130126.localdomain>
     [not found]             ` <55417DFD.1040207@huawei.com>
2015-04-30  7:51               ` Cyril Hrubis [this message]
2015-04-30  7:52               ` Cyril Hrubis

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20150430075108.GC479@rei.suse.de \
    --to=chrubis@suse.cz \
    --cc=cuibixuan@huawei.com \
    --cc=ltp-list@lists.sourceforge.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox