Re: [Buildroot] [PATCH 08/16] docs/manual: check-package before submitting patch

[Ricardo Martincoski <ricardo.martincoski@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 2044 bytes --]

Hello,

On Wed, Jul 27, 2022 at 10:22 AM, Romain Naour wrote:

> Le 24/07/2022 à 07:49, Ricardo Martincoski a écrit :
>> Add 'make check-package' to the default workflow of submitting patches,
>> just after the rebase and before using format-patch.
>> 
>> Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
>> Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com>
>> ---
>>  docs/manual/contribute.txt | 6 ++++++
>>  1 file changed, 6 insertions(+)
>> 
>> diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
>> index e588c69be6..c5652af7a0 100644
>> --- a/docs/manual/contribute.txt
>> +++ b/docs/manual/contribute.txt
>> @@ -294,6 +294,12 @@ $ git fetch --all --tags
>>  $ git rebase origin/master
>>  ---------------------
>>  
>> +Now run some basic checks for the changes you committed:
> 
> "some basic checks" may be not really meaningful for newcomers.

Indeed.

> 
> I would add a small description of what check-package really does.

Maybe:
Now check the coding style for the changes you committed:

Notice that the hyperlink to the section that describes what it does is right
above the added text.

282 Buildroot provides a handy tool to check for common coding style
283 mistakes on files you created or modified, called +check-package+ (see
284 xref:check-package[] for more information).
285
286 ==== Preparing a patch series
287
288 Starting from the changes committed in your local git view, _rebase_
289 your development branch on top of the upstream tree before generating
290 a patch set. To do so, run:
291
292 ---------------------
293 $ git fetch --all --tags
294 $ git rebase origin/master
295 ---------------------
296 
297 Now check the coding style for the changes you committed:
298 
299 ---------------------
300 $ make check-package
301 ---------------------
302 
303 Now, you are ready to generate then submit your patch set.


Regards,
Ricardo

[-- Attachment #2: Type: text/plain, Size: 150 bytes --]

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot