diff mbox

[rdma-core,5/5] Documentation: update stable doc about ABI reference generation

Message ID 4bbfedda-eab7-0320-2a37-e3ecbf1093dc@suse.de (mailing list archive)
State Superseded
Headers show

Commit Message

Nicolas Morey-Chaisemartin Nov. 14, 2017, 6:58 p.m. UTC
Signed-off-by: Nicolas Morey-Chaisemartin <NMoreyChaisemartin@suse.com>
---
 Documentation/stable.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Leon Romanovsky Nov. 15, 2017, 5:53 a.m. UTC | #1
On Tue, Nov 14, 2017 at 07:58:12PM +0100, Nicolas Morey-Chaisemartin wrote:
> Signed-off-by: Nicolas Morey-Chaisemartin <NMoreyChaisemartin@suse.com>
> ---
>  Documentation/stable.md | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
>
> diff --git a/Documentation/stable.md b/Documentation/stable.md
> index d7ea9822..b7d26c98 100644
> --- a/Documentation/stable.md
> +++ b/Documentation/stable.md
> @@ -63,3 +63,20 @@ Note that for Option 3, if the patch deviates from the original upstream patch (
>  ## Versioning
>
>  See versioning.md for setting package version on a stable branch.
> +
> +
> +## Creating a stable branch
> +
> +Stable branch should be created from a release tag of the master branch.
> +The first thing to do on a master branch is to commit the mainstream release ABI infos
> +so that latters patches/fixes can be checked against this reference.

Does it mean that you should rebase your stable-v15 branch?
It doesn't contain ABI infos yet.

> +
> +To do that, the creator of the branch should run
> +```
> +./buildlib/gen-abi
> +mv build-abi/ABI buildlib/ABI
> +git add buildlib/ABI
> +git commit
> +```
> +
> +Note that the ABI must NOT be commited at any point in the master branch.
> --
> 2.15.0.168.g9a51f1b30.dirty
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
Nicolas Morey-Chaisemartin Nov. 15, 2017, 5:26 p.m. UTC | #2
Le 15/11/2017 à 06:53, Leon Romanovsky a écrit :
> On Tue, Nov 14, 2017 at 07:58:12PM +0100, Nicolas Morey-Chaisemartin wrote:
>> Signed-off-by: Nicolas Morey-Chaisemartin <NMoreyChaisemartin@suse.com>
>> ---
>>  Documentation/stable.md | 17 +++++++++++++++++
>>  1 file changed, 17 insertions(+)
>>
>> diff --git a/Documentation/stable.md b/Documentation/stable.md
>> index d7ea9822..b7d26c98 100644
>> --- a/Documentation/stable.md
>> +++ b/Documentation/stable.md
>> @@ -63,3 +63,20 @@ Note that for Option 3, if the patch deviates from the original upstream patch (
>>  ## Versioning
>>
>>  See versioning.md for setting package version on a stable branch.
>> +
>> +
>> +## Creating a stable branch
>> +
>> +Stable branch should be created from a release tag of the master branch.
>> +The first thing to do on a master branch is to commit the mainstream release ABI infos
>> +so that latters patches/fixes can be checked against this reference.
> Does it mean that you should rebase your stable-v15 branch?
> It doesn't contain ABI infos yet.

I checked that the current stable-v15 passes the travis-checkabi manually (by generating the ABI from the v15 tag).
So no need there.
Once this series is accepted, I'll backport it to stable-v15 and generate a clean ABI ref from the v15 tag (and commit it)

Nicolas
--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/stable.md b/Documentation/stable.md
index d7ea9822..b7d26c98 100644
--- a/Documentation/stable.md
+++ b/Documentation/stable.md
@@ -63,3 +63,20 @@  Note that for Option 3, if the patch deviates from the original upstream patch (
 ## Versioning
 
 See versioning.md for setting package version on a stable branch.
+
+
+## Creating a stable branch
+
+Stable branch should be created from a release tag of the master branch.
+The first thing to do on a master branch is to commit the mainstream release ABI infos
+so that latters patches/fixes can be checked against this reference.
+
+To do that, the creator of the branch should run
+```
+./buildlib/gen-abi
+mv build-abi/ABI buildlib/ABI
+git add buildlib/ABI
+git commit
+```
+
+Note that the ABI must NOT be commited at any point in the master branch.