← Back to branch summary

~vanvugt/mir/clarify-ClientLatency

« back to all changes in this revision

Viewing changes to doc/dso_versioning_guide.md

  • Committer: Tarmac
  • Author(s): Daniel van Vugt
  • Date: 2016-04-01 03:36:18 UTC
  • mfrom: (3425.2.2 nextrelease)
  • Revision ID: tarmac-20160401033618-sw4ro8adpd4ydj1r
Drop the 'unreleased' nomenclature in symbols.map. Aside from the fact
that we need to remember (and do forget) to change it at release, we
already know what that next release will be. So the intermediate step of
naming stanzas 'unreleased' is not necessary.

This makes the release process less error prone and a bit quicker.

Approved by mir-ci-bot, Alberto Aguirre, Kevin DuBois, Andreas Pokorny, Alan Griffiths.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/dso_versioning_guide.md
6
6
 
7
7
There are more detailed descriptions below, but as a general rule:
8
8
 
9
 
 - If you add a new symbol, add it to the `*_unreleased` version stanza,
10
 
   like `MIR_CLIENT_unreleased`, `MIR_PLATFORM_unreleased`, etc.
 
9
 - If you add a new symbol, add it to a `*_NEXTSERIES` version stanza,
 
10
   like `MIR_CLIENT_0.22`, `MIR_PLATFORM_0.22`, etc representing the
 
11
   next future Mir series in which the new symbol will first be released.
11
12
 - If you change the behaviour or signature of a symbol _and_ wish to preserve
12
13
   backward compatibility, see "Change symbols without breaking ABI" below.
13
14
 - At release time, rename the current `*_unversioned` stanzas to have the
95
96
            /* Other symbols go here */
96
97
    };
97
98
 
98
 
    MIR_CLIENT_unreleased {
 
99
    MIR_CLIENT_0.18 {
99
100
        global:
100
101
            mir_connect_new_symbol;
101
102
        local:
138
139
    /* The old implementation */
139
140
 
140
141
    /* The @@ specifies that this is the default version */
141
 
    __asm__(".symver mir_connection_create_surface,mir_connection_create_surface@@@MIR_CLIENT_unreleased");
 
142
    __asm__(".symver mir_connection_create_surface,mir_connection_create_surface@@@MIR_CLIENT_0.18");
142
143
    MirWaitHandle* mir_connection_create_surface(...)
143
144
    /* The new implementation */
144
145
 
151
152
            ...
152
153
    };
153
154
 
154
 
    MIR_CLIENT_unreleased {
 
155
    MIR_CLIENT_0.18 {
155
156
        global:
156
157
            ...
157
158
            mir_connection_create_surface;