5_source_files/52_spacing.md | 29 +++++++++++++++++++- 5_source_files/README.md | 17 ++++++++---- README.md | 2 ++ 3 files changed, 42 insertions(+), 6 deletions(-)
We've discussed these ideas repeatedly over time; I'm now attempting to
formalize them. Also test-driving the documentation contribution
process.
- Repo: https://github.com/lersek/edk2-CCodingStandardsSpecification.git
- Branch: line_wrapping
- Rendered views of the pages modified:
- https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c-coding-standards-sp/content/v/line_wrapping/#edk-ii-c-coding-standards-specification
- https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c-coding-standards-sp/content/v/line_wrapping/5_source_files/#51-general-rules
- https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c-coding-standards-sp/content/v/line_wrapping/5_source_files/52_spacing.html#52-spacing
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Thanks
Laszlo
Laszlo Ersek (2):
Source Files / General Rules: limit line lengths to 80 columns
Source Files / Spacing / Multi-line func. calls: allow condensed
arguments
5_source_files/52_spacing.md | 29 +++++++++++++++++++-
5_source_files/README.md | 17 ++++++++----
README.md | 2 ++
3 files changed, 42 insertions(+), 6 deletions(-)
--
2.13.1.3.g8be5a757fa67
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Laszlo, You can also provide links to the GitHub commits with "?w=1" flag appended. If you select the "Display the rich diff" button above each changed file, GitHub renders a view with change bars. https://github.com/lersek/edk2-CCodingStandardsSpecification/commit/2c5534a24b15616fdaa02478858ed1d8908dc653?w=1 https://github.com/lersek/edk2-CCodingStandardsSpecification/commit/e3797dc48316052005cefa26246ab2fd32641881?w=1 Best regards, Mike > -----Original Message----- > From: Laszlo Ersek [mailto:lersek@redhat.com] > Sent: Friday, August 11, 2017 9:49 AM > To: edk2-devel-01 <edk2-devel@lists.01.org> > Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>; Justen, Jordan L > <jordan.l.justen@intel.com>; Leif Lindholm > <leif.lindholm@linaro.org>; Kinney, Michael D > <michael.d.kinney@intel.com> > Subject: [edk2-CCodingStandardsSpecification PATCH 0/2] > improvements related to line wrapping > > We've discussed these ideas repeatedly over time; I'm now > attempting to > formalize them. Also test-driving the documentation contribution > process. > > - Repo: https://github.com/lersek/edk2- > CCodingStandardsSpecification.git > - Branch: line_wrapping > - Rendered views of the pages modified: > - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- > coding-standards-sp/content/v/line_wrapping/#edk-ii-c-coding- > standards-specification > - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- > coding-standards-sp/content/v/line_wrapping/5_source_files/#51- > general-rules > - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- > coding-standards- > sp/content/v/line_wrapping/5_source_files/52_spacing.html#52- > spacing > > Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org> > Cc: Jordan Justen <jordan.l.justen@intel.com> > Cc: Leif Lindholm <leif.lindholm@linaro.org> > Cc: Michael D Kinney <michael.d.kinney@intel.com> > > Thanks > Laszlo > > Laszlo Ersek (2): > Source Files / General Rules: limit line lengths to 80 columns > Source Files / Spacing / Multi-line func. calls: allow > condensed > arguments > > 5_source_files/52_spacing.md | 29 +++++++++++++++++++- > 5_source_files/README.md | 17 ++++++++---- > README.md | 2 ++ > 3 files changed, 42 insertions(+), 6 deletions(-) > > -- > 2.13.1.3.g8be5a757fa67 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
Mike, On 08/11/17 19:07, Kinney, Michael D wrote: > Laszlo, > > You can also provide links to the GitHub commits with "?w=1" > flag appended. If you select the "Display the rich diff" button > above each changed file, GitHub renders a view with change bars. > > https://github.com/lersek/edk2-CCodingStandardsSpecification/commit/2c5534a24b15616fdaa02478858ed1d8908dc653?w=1 I opened two browser tabs with this link, one without "?w=1" and another with "?w=1", and compared the contents visually (by switching back and forth between the tabs), checking each screen-ful. I'm not seeing any differences. When I click the button that you mention, I do get a rendered diff as well. I wonder if this feature is javascript-only, or if it can be triggered with URL changes. Thanks Laszlo > > https://github.com/lersek/edk2-CCodingStandardsSpecification/commit/e3797dc48316052005cefa26246ab2fd32641881?w=1 > > Best regards, > > Mike > >> -----Original Message----- >> From: Laszlo Ersek [mailto:lersek@redhat.com] >> Sent: Friday, August 11, 2017 9:49 AM >> To: edk2-devel-01 <edk2-devel@lists.01.org> >> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>; Justen, Jordan L >> <jordan.l.justen@intel.com>; Leif Lindholm >> <leif.lindholm@linaro.org>; Kinney, Michael D >> <michael.d.kinney@intel.com> >> Subject: [edk2-CCodingStandardsSpecification PATCH 0/2] >> improvements related to line wrapping >> >> We've discussed these ideas repeatedly over time; I'm now >> attempting to >> formalize them. Also test-driving the documentation contribution >> process. >> >> - Repo: https://github.com/lersek/edk2- >> CCodingStandardsSpecification.git >> - Branch: line_wrapping >> - Rendered views of the pages modified: >> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- >> coding-standards-sp/content/v/line_wrapping/#edk-ii-c-coding- >> standards-specification >> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- >> coding-standards-sp/content/v/line_wrapping/5_source_files/#51- >> general-rules >> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- >> coding-standards- >> sp/content/v/line_wrapping/5_source_files/52_spacing.html#52- >> spacing >> >> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org> >> Cc: Jordan Justen <jordan.l.justen@intel.com> >> Cc: Leif Lindholm <leif.lindholm@linaro.org> >> Cc: Michael D Kinney <michael.d.kinney@intel.com> >> >> Thanks >> Laszlo >> >> Laszlo Ersek (2): >> Source Files / General Rules: limit line lengths to 80 columns >> Source Files / Spacing / Multi-line func. calls: allow >> condensed >> arguments >> >> 5_source_files/52_spacing.md | 29 +++++++++++++++++++- >> 5_source_files/README.md | 17 ++++++++---- >> README.md | 2 ++ >> 3 files changed, 42 insertions(+), 6 deletions(-) >> >> -- >> 2.13.1.3.g8be5a757fa67 > _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
Laszlo, If you only change a couple of words in a sentence, it will show the differences at the work level instead of the line level. If you add/remove entire paragraphs, then you will not see any differences. I am just in the habit of always adding ?w=1 to provide the best possible review format. I have not found a URL to auto select that view. When a single patch changes several files, you get that button for each file within the patch. Mike > -----Original Message----- > From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On > Behalf Of Laszlo Ersek > Sent: Tuesday, August 15, 2017 4:01 AM > To: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel- > 01 <edk2-devel@lists.01.org> > Cc: Justen, Jordan L <jordan.l.justen@intel.com>; Leif Lindholm > <leif.lindholm@linaro.org>; Ard Biesheuvel > <ard.biesheuvel@linaro.org> > Subject: Re: [edk2] [edk2-CCodingStandardsSpecification PATCH > 0/2] improvements related to line wrapping > > Mike, > > On 08/11/17 19:07, Kinney, Michael D wrote: > > Laszlo, > > > > You can also provide links to the GitHub commits with "?w=1" > > flag appended. If you select the "Display the rich diff" > button > > above each changed file, GitHub renders a view with change > bars. > > > > https://github.com/lersek/edk2- > CCodingStandardsSpecification/commit/2c5534a24b15616fdaa02478858 > ed1d8908dc653?w=1 > > I opened two browser tabs with this link, one without "?w=1" and > another > with "?w=1", and compared the contents visually (by switching > back and > forth between the tabs), checking each screen-ful. I'm not > seeing any > differences. > > When I click the button that you mention, I do get a rendered > diff as > well. I wonder if this feature is javascript-only, or if it can > be > triggered with URL changes. > > Thanks > Laszlo > > > > > https://github.com/lersek/edk2- > CCodingStandardsSpecification/commit/e3797dc48316052005cefa26246 > ab2fd32641881?w=1 > > > > Best regards, > > > > Mike > > > >> -----Original Message----- > >> From: Laszlo Ersek [mailto:lersek@redhat.com] > >> Sent: Friday, August 11, 2017 9:49 AM > >> To: edk2-devel-01 <edk2-devel@lists.01.org> > >> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>; Justen, > Jordan L > >> <jordan.l.justen@intel.com>; Leif Lindholm > >> <leif.lindholm@linaro.org>; Kinney, Michael D > >> <michael.d.kinney@intel.com> > >> Subject: [edk2-CCodingStandardsSpecification PATCH 0/2] > >> improvements related to line wrapping > >> > >> We've discussed these ideas repeatedly over time; I'm now > >> attempting to > >> formalize them. Also test-driving the documentation > contribution > >> process. > >> > >> - Repo: https://github.com/lersek/edk2- > >> CCodingStandardsSpecification.git > >> - Branch: line_wrapping > >> - Rendered views of the pages modified: > >> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- > >> coding-standards-sp/content/v/line_wrapping/#edk-ii-c-coding- > >> standards-specification > >> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- > >> coding-standards- > sp/content/v/line_wrapping/5_source_files/#51- > >> general-rules > >> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- > >> coding-standards- > >> sp/content/v/line_wrapping/5_source_files/52_spacing.html#52- > >> spacing > >> > >> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org> > >> Cc: Jordan Justen <jordan.l.justen@intel.com> > >> Cc: Leif Lindholm <leif.lindholm@linaro.org> > >> Cc: Michael D Kinney <michael.d.kinney@intel.com> > >> > >> Thanks > >> Laszlo > >> > >> Laszlo Ersek (2): > >> Source Files / General Rules: limit line lengths to 80 > columns > >> Source Files / Spacing / Multi-line func. calls: allow > >> condensed > >> arguments > >> > >> 5_source_files/52_spacing.md | 29 +++++++++++++++++++- > >> 5_source_files/README.md | 17 ++++++++---- > >> README.md | 2 ++ > >> 3 files changed, 42 insertions(+), 6 deletions(-) > >> > >> -- > >> 2.13.1.3.g8be5a757fa67 > > > > _______________________________________________ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
On 08/15/17 17:17, Kinney, Michael D wrote: > Laszlo, > > If you only change a couple of words in a sentence, it will > show the differences at the work level instead of the line > level. This crossed my mind, but when I compared the two views, I saw the word-level highlighting (on top of the line-level highlighting) even under the URL without the w=1 parameter. I was confused. > If you add/remove entire paragraphs, then you will > not see any differences. I am just in the habit of always > adding ?w=1 to provide the best possible review format. > > I have not found a URL to auto select that view. When a > single patch changes several files, you get that button for > each file within the patch. I'll try to remember adding such URLs to the blurb that require the least amount of clicks in order to end up with a "rich diff". Thanks! Laszlo >> -----Original Message----- >> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On >> Behalf Of Laszlo Ersek >> Sent: Tuesday, August 15, 2017 4:01 AM >> To: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel- >> 01 <edk2-devel@lists.01.org> >> Cc: Justen, Jordan L <jordan.l.justen@intel.com>; Leif Lindholm >> <leif.lindholm@linaro.org>; Ard Biesheuvel >> <ard.biesheuvel@linaro.org> >> Subject: Re: [edk2] [edk2-CCodingStandardsSpecification PATCH >> 0/2] improvements related to line wrapping >> >> Mike, >> >> On 08/11/17 19:07, Kinney, Michael D wrote: >>> Laszlo, >>> >>> You can also provide links to the GitHub commits with "?w=1" >>> flag appended. If you select the "Display the rich diff" >> button >>> above each changed file, GitHub renders a view with change >> bars. >>> >>> https://github.com/lersek/edk2- >> CCodingStandardsSpecification/commit/2c5534a24b15616fdaa02478858 >> ed1d8908dc653?w=1 >> >> I opened two browser tabs with this link, one without "?w=1" and >> another >> with "?w=1", and compared the contents visually (by switching >> back and >> forth between the tabs), checking each screen-ful. I'm not >> seeing any >> differences. >> >> When I click the button that you mention, I do get a rendered >> diff as >> well. I wonder if this feature is javascript-only, or if it can >> be >> triggered with URL changes. >> >> Thanks >> Laszlo >> >>> >>> https://github.com/lersek/edk2- >> CCodingStandardsSpecification/commit/e3797dc48316052005cefa26246 >> ab2fd32641881?w=1 >>> >>> Best regards, >>> >>> Mike >>> >>>> -----Original Message----- >>>> From: Laszlo Ersek [mailto:lersek@redhat.com] >>>> Sent: Friday, August 11, 2017 9:49 AM >>>> To: edk2-devel-01 <edk2-devel@lists.01.org> >>>> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>; Justen, >> Jordan L >>>> <jordan.l.justen@intel.com>; Leif Lindholm >>>> <leif.lindholm@linaro.org>; Kinney, Michael D >>>> <michael.d.kinney@intel.com> >>>> Subject: [edk2-CCodingStandardsSpecification PATCH 0/2] >>>> improvements related to line wrapping >>>> >>>> We've discussed these ideas repeatedly over time; I'm now >>>> attempting to >>>> formalize them. Also test-driving the documentation >> contribution >>>> process. >>>> >>>> - Repo: https://github.com/lersek/edk2- >>>> CCodingStandardsSpecification.git >>>> - Branch: line_wrapping >>>> - Rendered views of the pages modified: >>>> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- >>>> coding-standards-sp/content/v/line_wrapping/#edk-ii-c-coding- >>>> standards-specification >>>> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- >>>> coding-standards- >> sp/content/v/line_wrapping/5_source_files/#51- >>>> general-rules >>>> - https://lersek.gitbooks.io/laszlo-s-fork-of-the-edk-ii-c- >>>> coding-standards- >>>> sp/content/v/line_wrapping/5_source_files/52_spacing.html#52- >>>> spacing >>>> >>>> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org> >>>> Cc: Jordan Justen <jordan.l.justen@intel.com> >>>> Cc: Leif Lindholm <leif.lindholm@linaro.org> >>>> Cc: Michael D Kinney <michael.d.kinney@intel.com> >>>> >>>> Thanks >>>> Laszlo >>>> >>>> Laszlo Ersek (2): >>>> Source Files / General Rules: limit line lengths to 80 >> columns >>>> Source Files / Spacing / Multi-line func. calls: allow >>>> condensed >>>> arguments >>>> >>>> 5_source_files/52_spacing.md | 29 +++++++++++++++++++- >>>> 5_source_files/README.md | 17 ++++++++---- >>>> README.md | 2 ++ >>>> 3 files changed, 42 insertions(+), 6 deletions(-) >>>> >>>> -- >>>> 2.13.1.3.g8be5a757fa67 >>> >> >> _______________________________________________ >> edk2-devel mailing list >> edk2-devel@lists.01.org >> https://lists.01.org/mailman/listinfo/edk2-devel _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
© 2016 - 2024 Red Hat, Inc.