* [dpdk-dev] [PATCH] doc: fix abi check script examples
@ 2019-03-19 14:05 David Marchand
2019-03-19 14:05 ` David Marchand
2019-03-19 17:19 ` Neil Horman
0 siblings, 2 replies; 6+ messages in thread
From: David Marchand @ 2019-03-19 14:05 UTC (permalink / raw)
To: dev; +Cc: stable, Olivier Matz, Neil Horman
The doc examples are not aligned on the script following the
incriminated commit.
Fixes: c4a5fe3bf832 ("devtools: rework ABI checker script")
Cc: stable@dpdk.org
Cc: Olivier Matz <olivier.matz@6wind.com>
Cc: Neil Horman <nhorman@tuxdriver.com>
Signed-off-by: David Marchand <david.marchand@redhat.com>
---
doc/guides/contributing/versioning.rst | 19 +++++++++++--------
1 file changed, 11 insertions(+), 8 deletions(-)
diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst
index e7b326b..98b8de3 100644
--- a/doc/guides/contributing/versioning.rst
+++ b/doc/guides/contributing/versioning.rst
@@ -548,26 +548,29 @@ utilities which can be installed via a package manager. For example::
The syntax of the ``validate-abi.sh`` utility is::
- ./devtools/validate-abi.sh <REV1> <REV2> <TARGET>
+ ./devtools/validate-abi.sh <REV1> <REV2>
Where ``REV1`` and ``REV2`` are valid gitrevisions(7)
https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html
-on the local repo and target is the usual DPDK compilation target.
+on the local repo.
For example::
# Check between the previous and latest commit:
- ./devtools/validate-abi.sh HEAD~1 HEAD x86_64-native-linux-gcc
+ ./devtools/validate-abi.sh HEAD~1 HEAD
+
+ # Check on a specific compilation target:
+ ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD
# Check between two tags:
- ./devtools/validate-abi.sh v2.0.0 v2.1.0 x86_64-native-linux-gcc
+ ./devtools/validate-abi.sh v2.0.0 v2.1.0
# Check between git master and local topic-branch "vhost-hacking":
- ./devtools/validate-abi.sh master vhost-hacking x86_64-native-linux-gcc
+ ./devtools/validate-abi.sh master vhost-hacking
After the validation script completes (it can take a while since it need to
compile both tags) it will create compatibility reports in the
-``./compat_report`` directory. Listed incompatibilities can be found as
-follows::
+``./abi-check/compat_report`` directory. Listed incompatibilities can be found
+as follows::
- grep -lr Incompatible compat_reports/
+ grep -lr Incompatible abi-check/compat_reports/
--
1.8.3.1
^ permalink raw reply [flat|nested] 6+ messages in thread* [dpdk-dev] [PATCH] doc: fix abi check script examples
2019-03-19 14:05 [dpdk-dev] [PATCH] doc: fix abi check script examples David Marchand
@ 2019-03-19 14:05 ` David Marchand
2019-03-19 17:19 ` Neil Horman
1 sibling, 0 replies; 6+ messages in thread
From: David Marchand @ 2019-03-19 14:05 UTC (permalink / raw)
To: dev; +Cc: stable, Olivier Matz, Neil Horman
The doc examples are not aligned on the script following the
incriminated commit.
Fixes: c4a5fe3bf832 ("devtools: rework ABI checker script")
Cc: stable@dpdk.org
Cc: Olivier Matz <olivier.matz@6wind.com>
Cc: Neil Horman <nhorman@tuxdriver.com>
Signed-off-by: David Marchand <david.marchand@redhat.com>
---
doc/guides/contributing/versioning.rst | 19 +++++++++++--------
1 file changed, 11 insertions(+), 8 deletions(-)
diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst
index e7b326b..98b8de3 100644
--- a/doc/guides/contributing/versioning.rst
+++ b/doc/guides/contributing/versioning.rst
@@ -548,26 +548,29 @@ utilities which can be installed via a package manager. For example::
The syntax of the ``validate-abi.sh`` utility is::
- ./devtools/validate-abi.sh <REV1> <REV2> <TARGET>
+ ./devtools/validate-abi.sh <REV1> <REV2>
Where ``REV1`` and ``REV2`` are valid gitrevisions(7)
https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html
-on the local repo and target is the usual DPDK compilation target.
+on the local repo.
For example::
# Check between the previous and latest commit:
- ./devtools/validate-abi.sh HEAD~1 HEAD x86_64-native-linux-gcc
+ ./devtools/validate-abi.sh HEAD~1 HEAD
+
+ # Check on a specific compilation target:
+ ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD
# Check between two tags:
- ./devtools/validate-abi.sh v2.0.0 v2.1.0 x86_64-native-linux-gcc
+ ./devtools/validate-abi.sh v2.0.0 v2.1.0
# Check between git master and local topic-branch "vhost-hacking":
- ./devtools/validate-abi.sh master vhost-hacking x86_64-native-linux-gcc
+ ./devtools/validate-abi.sh master vhost-hacking
After the validation script completes (it can take a while since it need to
compile both tags) it will create compatibility reports in the
-``./compat_report`` directory. Listed incompatibilities can be found as
-follows::
+``./abi-check/compat_report`` directory. Listed incompatibilities can be found
+as follows::
- grep -lr Incompatible compat_reports/
+ grep -lr Incompatible abi-check/compat_reports/
--
1.8.3.1
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [dpdk-dev] [PATCH] doc: fix abi check script examples
2019-03-19 14:05 [dpdk-dev] [PATCH] doc: fix abi check script examples David Marchand
2019-03-19 14:05 ` David Marchand
@ 2019-03-19 17:19 ` Neil Horman
2019-03-19 17:19 ` Neil Horman
2019-04-05 8:30 ` Thomas Monjalon
1 sibling, 2 replies; 6+ messages in thread
From: Neil Horman @ 2019-03-19 17:19 UTC (permalink / raw)
To: David Marchand; +Cc: dev, stable, Olivier Matz
On Tue, Mar 19, 2019 at 03:05:18PM +0100, David Marchand wrote:
> The doc examples are not aligned on the script following the
> incriminated commit.
>
> Fixes: c4a5fe3bf832 ("devtools: rework ABI checker script")
> Cc: stable@dpdk.org
>
> Cc: Olivier Matz <olivier.matz@6wind.com>
> Cc: Neil Horman <nhorman@tuxdriver.com>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> doc/guides/contributing/versioning.rst | 19 +++++++++++--------
> 1 file changed, 11 insertions(+), 8 deletions(-)
>
> diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst
> index e7b326b..98b8de3 100644
> --- a/doc/guides/contributing/versioning.rst
> +++ b/doc/guides/contributing/versioning.rst
> @@ -548,26 +548,29 @@ utilities which can be installed via a package manager. For example::
>
> The syntax of the ``validate-abi.sh`` utility is::
>
> - ./devtools/validate-abi.sh <REV1> <REV2> <TARGET>
> + ./devtools/validate-abi.sh <REV1> <REV2>
>
> Where ``REV1`` and ``REV2`` are valid gitrevisions(7)
> https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html
> -on the local repo and target is the usual DPDK compilation target.
> +on the local repo.
>
> For example::
>
> # Check between the previous and latest commit:
> - ./devtools/validate-abi.sh HEAD~1 HEAD x86_64-native-linux-gcc
> + ./devtools/validate-abi.sh HEAD~1 HEAD
> +
> + # Check on a specific compilation target:
> + ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD
>
> # Check between two tags:
> - ./devtools/validate-abi.sh v2.0.0 v2.1.0 x86_64-native-linux-gcc
> + ./devtools/validate-abi.sh v2.0.0 v2.1.0
>
> # Check between git master and local topic-branch "vhost-hacking":
> - ./devtools/validate-abi.sh master vhost-hacking x86_64-native-linux-gcc
> + ./devtools/validate-abi.sh master vhost-hacking
>
> After the validation script completes (it can take a while since it need to
> compile both tags) it will create compatibility reports in the
> -``./compat_report`` directory. Listed incompatibilities can be found as
> -follows::
> +``./abi-check/compat_report`` directory. Listed incompatibilities can be found
> +as follows::
>
> - grep -lr Incompatible compat_reports/
> + grep -lr Incompatible abi-check/compat_reports/
> --
> 1.8.3.1
>
>
Acked-by: Neil Horman <nhorman@tuxdriver.com>
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [dpdk-dev] [PATCH] doc: fix abi check script examples
2019-03-19 17:19 ` Neil Horman
@ 2019-03-19 17:19 ` Neil Horman
2019-04-05 8:30 ` Thomas Monjalon
1 sibling, 0 replies; 6+ messages in thread
From: Neil Horman @ 2019-03-19 17:19 UTC (permalink / raw)
To: David Marchand; +Cc: dev, stable, Olivier Matz
On Tue, Mar 19, 2019 at 03:05:18PM +0100, David Marchand wrote:
> The doc examples are not aligned on the script following the
> incriminated commit.
>
> Fixes: c4a5fe3bf832 ("devtools: rework ABI checker script")
> Cc: stable@dpdk.org
>
> Cc: Olivier Matz <olivier.matz@6wind.com>
> Cc: Neil Horman <nhorman@tuxdriver.com>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> doc/guides/contributing/versioning.rst | 19 +++++++++++--------
> 1 file changed, 11 insertions(+), 8 deletions(-)
>
> diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst
> index e7b326b..98b8de3 100644
> --- a/doc/guides/contributing/versioning.rst
> +++ b/doc/guides/contributing/versioning.rst
> @@ -548,26 +548,29 @@ utilities which can be installed via a package manager. For example::
>
> The syntax of the ``validate-abi.sh`` utility is::
>
> - ./devtools/validate-abi.sh <REV1> <REV2> <TARGET>
> + ./devtools/validate-abi.sh <REV1> <REV2>
>
> Where ``REV1`` and ``REV2`` are valid gitrevisions(7)
> https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html
> -on the local repo and target is the usual DPDK compilation target.
> +on the local repo.
>
> For example::
>
> # Check between the previous and latest commit:
> - ./devtools/validate-abi.sh HEAD~1 HEAD x86_64-native-linux-gcc
> + ./devtools/validate-abi.sh HEAD~1 HEAD
> +
> + # Check on a specific compilation target:
> + ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD
>
> # Check between two tags:
> - ./devtools/validate-abi.sh v2.0.0 v2.1.0 x86_64-native-linux-gcc
> + ./devtools/validate-abi.sh v2.0.0 v2.1.0
>
> # Check between git master and local topic-branch "vhost-hacking":
> - ./devtools/validate-abi.sh master vhost-hacking x86_64-native-linux-gcc
> + ./devtools/validate-abi.sh master vhost-hacking
>
> After the validation script completes (it can take a while since it need to
> compile both tags) it will create compatibility reports in the
> -``./compat_report`` directory. Listed incompatibilities can be found as
> -follows::
> +``./abi-check/compat_report`` directory. Listed incompatibilities can be found
> +as follows::
>
> - grep -lr Incompatible compat_reports/
> + grep -lr Incompatible abi-check/compat_reports/
> --
> 1.8.3.1
>
>
Acked-by: Neil Horman <nhorman@tuxdriver.com>
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [dpdk-dev] [PATCH] doc: fix abi check script examples
2019-03-19 17:19 ` Neil Horman
2019-03-19 17:19 ` Neil Horman
@ 2019-04-05 8:30 ` Thomas Monjalon
2019-04-05 8:30 ` Thomas Monjalon
1 sibling, 1 reply; 6+ messages in thread
From: Thomas Monjalon @ 2019-04-05 8:30 UTC (permalink / raw)
To: David Marchand; +Cc: dev, Neil Horman, stable, Olivier Matz
19/03/2019 18:19, Neil Horman:
> On Tue, Mar 19, 2019 at 03:05:18PM +0100, David Marchand wrote:
> > The doc examples are not aligned on the script following the
> > incriminated commit.
> >
> > Fixes: c4a5fe3bf832 ("devtools: rework ABI checker script")
> > Cc: stable@dpdk.org
> >
> > Cc: Olivier Matz <olivier.matz@6wind.com>
> > Cc: Neil Horman <nhorman@tuxdriver.com>
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
> > ---
> Acked-by: Neil Horman <nhorman@tuxdriver.com>
Applied, thanks
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [dpdk-dev] [PATCH] doc: fix abi check script examples
2019-04-05 8:30 ` Thomas Monjalon
@ 2019-04-05 8:30 ` Thomas Monjalon
0 siblings, 0 replies; 6+ messages in thread
From: Thomas Monjalon @ 2019-04-05 8:30 UTC (permalink / raw)
To: David Marchand; +Cc: dev, Neil Horman, stable, Olivier Matz
19/03/2019 18:19, Neil Horman:
> On Tue, Mar 19, 2019 at 03:05:18PM +0100, David Marchand wrote:
> > The doc examples are not aligned on the script following the
> > incriminated commit.
> >
> > Fixes: c4a5fe3bf832 ("devtools: rework ABI checker script")
> > Cc: stable@dpdk.org
> >
> > Cc: Olivier Matz <olivier.matz@6wind.com>
> > Cc: Neil Horman <nhorman@tuxdriver.com>
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
> > ---
> Acked-by: Neil Horman <nhorman@tuxdriver.com>
Applied, thanks
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2019-04-05 8:30 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-03-19 14:05 [dpdk-dev] [PATCH] doc: fix abi check script examples David Marchand
2019-03-19 14:05 ` David Marchand
2019-03-19 17:19 ` Neil Horman
2019-03-19 17:19 ` Neil Horman
2019-04-05 8:30 ` Thomas Monjalon
2019-04-05 8:30 ` Thomas Monjalon
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).