[PATCH rtems-docs] eng/vc-users: Set up patch message with repo name

[Ida Delphine]

Yay!!!
Thanks for the feedback. Will try building the docs.

On Tue, 16 Mar 2021, 8:08 pm Gedare Bloom, <gedare at rtems.org> wrote:

> Hi Ida,
>
> I have built and checked the output, it looks good but I did make a
> tiny change to remove HEAD^ with ... to be a bit non-specific, and
> fixed a typo in your commit message. I would however like you to
> confirm that you can build the docs :) as your next step, it is best
> to confirm that patches you send build properly. Pull the updated repo
> and build it to confirm you see your change properly made.
>
> When I applied this patch, I got
> warning: 2 lines add whitespace errors.
> I have fixed those two lines where there was a whitespace character at
> the end of the line. Although that is not such a big deal in the docs,
> we prefer to avoid those trailing spaces in code. Keep that in mind.
> Maybe someday we'll have a proper style checker to help ;)
>
> Congratulations on your first contribution :)
>
> Gedare
>
> On Tue, Mar 16, 2021 at 12:31 PM Ida Delphine <idadelm at gmail.com> wrote:
> >
> > From: Meh Mbeh Ida Delphine <idadelm at gmail.com>
> >
> > Added instructions on how to set up a patch messahe with a repo name.
> >
> > Author:    Meh Mbeh Ida Delphine <idadelm at gmail.com>
> > Date:      Tue Mar 16 19:11:23 2021 +0100
> > ---
> >  eng/vc-users.rst | 8 ++++++++
> >  1 file changed, 8 insertions(+)
> >
> > diff --git a/eng/vc-users.rst b/eng/vc-users.rst
> > index 31de516..772019e 100644
> > --- a/eng/vc-users.rst
> > +++ b/eng/vc-users.rst
> > @@ -458,6 +458,14 @@ specify a version number for your patch, for
> example, use
> >
> >  to indicate the second version of a patch, ``-v3`` for a third, and so
> forth.
> >
> > +Also, in order to create a patch specifying the repo name in the patch
> message,
> > +you should use the``--subject-prefix`` flag. For example, if
> contributing to
> > +the rtems-docs repo, use
> > +
> > +.. code-block:: shell
> > +
> > +  git format-patch HEAD^ --subject-prefix="PATCH rtems-docs"
> > +
> >  Patches created using ``git format-patch`` are formatted so they can be
> emailed
> >  and rely on having Git configured with your name and email address, for
> example
> >
> > --
> > 2.25.1
> >
> > _______________________________________________
> > devel mailing list
> > devel at rtems.org
> > http://lists.rtems.org/mailman/listinfo/devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20210316/0b295dd5/attachment.html>