| Message ID | 20240714210908.3964010-1-matthias@pritschet.eu |
|---|---|
| State | New |
| Headers | show |
| Series | ref-manual: fix typo | expand |
Hi Matthias, On 7/14/24 11:09 PM, Matthias Pritschet via lists.yoctoproject.org wrote: > [You don't often get email from matthias=pritschet.eu@lists.yoctoproject.org. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ] > > changed one letter (s/B/A), so the sentence is correct again. I believe we need your Signed-off-by here, c.f. https://docs.yoctoproject.org/contributor-guide/submit-changes.html#implement-and-commit-changes """ For each commit to create, use the git commit -s command with the files or directories you want to include in the commit: [...] The -s option of git commit adds a “Signed-off-by:” line to your commit message. There is the same requirement for contributing to the Linux kernel. Adding such a line signifies that you, the submitter, have agreed to the Developer’s Certificate of Origin 1.1 as follows: [...] """ I could suggest extending the commit title a bit to give a little bit more info, e.g.: ref-manual: fix typo in SYSROOT_DIRS_IGNORE example > --- > documentation/ref-manual/variables.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst > index 848cea787..3709fca89 100644 > --- a/documentation/ref-manual/variables.rst > +++ b/documentation/ref-manual/variables.rst > @@ -8618,7 +8618,7 @@ system and gives an overview of their function and contents. > is just to show the usefulness of setting :term:`SYSROOT_DIRS`. > > When a recipe ``B`` :term:`DEPENDS` on ``A``, it means what is in > - :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``B`` > + :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``A`` Good catch :) Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> However, I also believe the example is for the wrong term? I think we should move the example to the SYSROOT_DIRS term instead as it's more appropriate. One can also write some example for SYSROOT_DIRS_IGNORE if there's a need for it. What do you think? If you agree, can you send a patch for that as well? Thanks! Quentin
Hi Quentin, thanks for reviewing. Am 15.07.24 um 09:45 schrieb Quentin Schulz: > Hi Matthias,> > On 7/14/24 11:09 PM, Matthias Pritschet via lists.yoctoproject.org wrote: >> [You don't often get email from matthias=pritschet.eu@lists.yoctoproject.org. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ] >> >> changed one letter (s/B/A), so the sentence is correct again. > > I believe we need your Signed-off-by here, c.f. https://docs.yoctoproject.org/contributor-guide/submit-changes.html#implement-and-commit-changes > > """ > For each commit to create, use the git commit -s command with the files or directories you want to include in the commit: > [...] > The -s option of git commit adds a “Signed-off-by:” line to your commit message. There is the same requirement for contributing to the Linux kernel. Adding such a line signifies that you, the submitter, have agreed to the Developer’s Certificate of Origin 1.1 as follows: > [...] > """ Ah, sorry. To my defense: the -s was not mentioned in the top level README. ;-) > > I could suggest extending the commit title a bit to give a little bit more info, e.g.: > > ref-manual: fix typo in SYSROOT_DIRS_IGNORE example > Makes sense, fixed in v2. >> --- >> documentation/ref-manual/variables.rst | 2 +- >> 1 file changed, 1 insertion(+), 1 deletion(-) >> >> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst >> index 848cea787..3709fca89 100644 >> --- a/documentation/ref-manual/variables.rst >> +++ b/documentation/ref-manual/variables.rst >> @@ -8618,7 +8618,7 @@ system and gives an overview of their function and contents. >> is just to show the usefulness of setting :term:`SYSROOT_DIRS`. >> >> When a recipe ``B`` :term:`DEPENDS` on ``A``, it means what is in >> - :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``B`` >> + :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``A`` > > Good catch :) > > Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> > > However, I also believe the example is for the wrong term? I think we should move the example to the SYSROOT_DIRS term instead as it's more appropriate. One can also write some example for SYSROOT_DIRS_IGNORE if there's a need for it. What do you think? If you agree, can you send a patch for that as well? I agree with the first part and have moved the example up to SYSROOTS_DIRS in v2. (I hope that's ok) Regarding SYSROOT_DIRS_IGNORE, I - being a novice myself - would say that it's sufficiently self-explanatory and there's no need for a dedicated example. I'm open to changing my mind though. There are a few usecases in meta which could serve as example. > > Thanks! > Quentin Thanks! Matthias
Hi Matthias, On 7/15/24 6:14 PM, Matthias Pritschet wrote: > Hi Quentin, > > thanks for reviewing. > > Am 15.07.24 um 09:45 schrieb Quentin Schulz: >> Hi Matthias,> On 7/14/24 11:09 PM, Matthias Pritschet via >> lists.yoctoproject.org wrote: >>> [You don't often get email from >>> matthias=pritschet.eu@lists.yoctoproject.org. Learn why this is >>> important at https://aka.ms/LearnAboutSenderIdentification ] >>> >>> changed one letter (s/B/A), so the sentence is correct again. >> >> I believe we need your Signed-off-by here, c.f. >> https://docs.yoctoproject.org/contributor-guide/submit-changes.html#implement-and-commit-changes >> >> """ >> For each commit to create, use the git commit -s command with the >> files or directories you want to include in the commit: >> [...] >> The -s option of git commit adds a “Signed-off-by:” line to your >> commit message. There is the same requirement for contributing to the >> Linux kernel. Adding such a line signifies that you, the submitter, >> have agreed to the Developer’s Certificate of Origin 1.1 as follows: >> [...] >> """ > Ah, sorry. > To my defense: the -s was not mentioned in the top level README. ;-) > Which top-level README? https://git.yoctoproject.org/yocto-docs/tree/README#n13 points to the guide I sent you yesterday. Mailing list contribution is something not everyone is familiar with, so I'm trying to understand how we could improve documentation around it :) Cheers, Quentin
Hi Quentin, Am 16.07.24 um 09:23 schrieb Quentin Schulz: > Hi Matthias, > > On 7/15/24 6:14 PM, Matthias Pritschet wrote: >> Hi Quentin, >> >> thanks for reviewing. >> >> Am 15.07.24 um 09:45 schrieb Quentin Schulz: >>> Hi Matthias,> On 7/14/24 11:09 PM, Matthias Pritschet via lists.yoctoproject.org wrote: >>>> [You don't often get email from matthias=pritschet.eu@lists.yoctoproject.org. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ] >>>> >>>> changed one letter (s/B/A), so the sentence is correct again. >>> >>> I believe we need your Signed-off-by here, c.f. https://docs.yoctoproject.org/contributor-guide/submit-changes.html#implement-and-commit-changes >>> >>> """ >>> For each commit to create, use the git commit -s command with the files or directories you want to include in the commit: >>> [...] >>> The -s option of git commit adds a “Signed-off-by:” line to your commit message. There is the same requirement for contributing to the Linux kernel. Adding such a line signifies that you, the submitter, have agreed to the Developer’s Certificate of Origin 1.1 as follows: >>> [...] >>> """ >> Ah, sorry. >> To my defense: the -s was not mentioned in the top level README. ;-) >> > > Which top-level README? I was referring to the command in https://git.yoctoproject.org/yocto-docs/tree/README#n19 , but it only occured to me now that the -s is part of the commit command and not part of the send-email command. You can ignore my stupid comment above. Sorry for the confusion. > > https://git.yoctoproject.org/yocto-docs/tree/README#n13 points to the guide I sent you yesterday. > > Mailing list contribution is something not everyone is familiar with, so I'm trying to understand how we could improve documentation around it :) As you might have guessed, this is my first contribution to a mailing list. I took some time to read through the documentation because I really didn't want to mess it up, and look how that worked out... ;-) Also, I just realized now that I should've had put you in Cc: of v2's commit message instead of using send-email's --cc . It's all there and well documented and if things are unclear, there's always the IRC. But it's just a lot of information to process and it's easy to forget little things once one is done reading. > > Cheers, > Quentin Anyway, thanks for your patience! Matthias
Hi Matthias, On 7/16/24 11:48 AM, Matthias Pritschet wrote: > Hi Quentin, > > Am 16.07.24 um 09:23 schrieb Quentin Schulz: >> Hi Matthias, >> >> On 7/15/24 6:14 PM, Matthias Pritschet wrote: >>> Hi Quentin, >>> >>> thanks for reviewing. >>> >>> Am 15.07.24 um 09:45 schrieb Quentin Schulz: >>>> Hi Matthias,> On 7/14/24 11:09 PM, Matthias Pritschet via >>>> lists.yoctoproject.org wrote: >>>>> [You don't often get email from >>>>> matthias=pritschet.eu@lists.yoctoproject.org. Learn why this is >>>>> important at https://aka.ms/LearnAboutSenderIdentification ] >>>>> >>>>> changed one letter (s/B/A), so the sentence is correct again. >>>> >>>> I believe we need your Signed-off-by here, c.f. >>>> https://docs.yoctoproject.org/contributor-guide/submit-changes.html#implement-and-commit-changes >>>> >>>> """ >>>> For each commit to create, use the git commit -s command with the >>>> files or directories you want to include in the commit: >>>> [...] >>>> The -s option of git commit adds a “Signed-off-by:” line to your >>>> commit message. There is the same requirement for contributing to >>>> the Linux kernel. Adding such a line signifies that you, the >>>> submitter, have agreed to the Developer’s Certificate of Origin 1.1 >>>> as follows: >>>> [...] >>>> """ >>> Ah, sorry. >>> To my defense: the -s was not mentioned in the top level README. ;-) >>> >> >> Which top-level README? > > I was referring to the command in > https://git.yoctoproject.org/yocto-docs/tree/README#n19 , but it only occured to me now that the -s is part of the commit command and not part of the send-email command. > You can ignore my stupid comment above. Sorry for the confusion. > Yup, cannot add the Signed-off-by tag outside of the git commit command I believe. >> >> https://git.yoctoproject.org/yocto-docs/tree/README#n13 points to the guide I sent you yesterday. >> >> Mailing list contribution is something not everyone is familiar with, >> so I'm trying to understand how we could improve documentation around >> it :) > > As you might have guessed, this is my first contribution to a mailing list. > I took some time to read through the documentation because I really > didn't want to mess it up, and look how that worked out... ;-) You did pretty well for a first patch actually, you're not the first to forget the Signed-off-by and won't be the last, some veteran contributors forget sometimes too. And you even had the v2 in the commit title for the v2 :) > Also, I just realized now that I should've had put you in Cc: of v2's > commit message instead of using send-email's --cc . > Nah, it's actually fine this way, we don't really make use of Cc: tag in the commit log. Adding people involved in earlier versions in (mail) cc of the later versions isn't required in most projects I contribute to, a nice thing to do, but not required (I rarely do it for example). One thing to do though is collect tags given on the mailing list, e.g. if there's a need for a v3, it'd be very welcome to have my Reviewed-by tag I gave by mail on the v2 make it to the v3 (provided the content didn't drastically change of course :) ). > It's all there and well documented and if things are unclear, there's > always the IRC. > But it's just a lot of information to process and it's easy to forget > little things once one is done reading. > Yeah I get that, but again, you've done well, don't you worry too much about it :) Don't hesitate to ask questions or for clarification. Cheers, Quentin
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 848cea787..3709fca89 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -8618,7 +8618,7 @@ system and gives an overview of their function and contents. is just to show the usefulness of setting :term:`SYSROOT_DIRS`. When a recipe ``B`` :term:`DEPENDS` on ``A``, it means what is in - :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``B`` + :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``A`` into ``B``'s :term:`SYSROOT_DESTDIR` that is "``${WORKDIR}/sysroot-destdir``". Now, since ``/opt/lib`` is not in :term:`SYSROOT_DIRS`, it will never be copied to