Skip to content

Commit 2628514

Browse files
committed
Merge pull request #1 from rjschwei/initSetup
Getting things rolling for the "new" LSB Two +1 votes, merging.
2 parents 2ec77ea + 6641183 commit 2628514

File tree

3 files changed

+155
-0
lines changed

3 files changed

+155
-0
lines changed

Contributing.txt

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
Contributing is easy, just fork the project on Github and send a pull-request
2+
when your changes are ready.
3+
4+
The core technical team of the LSB working group will review the pull request
5+
and once agreement is reached (2 or more +1) the request will be merged. The
6+
core technical team with repository commit access will abide by the same rules,
7+
i.e. members with commit access will send pull requests to allow public review
8+
of proposed changes.
9+
10+
The repository is structured into two major categories, documents and tests.
11+
The documents directory is structured to follow the work flow, problem
12+
statement -> proposed solution -> solution, the details are outlined below. The
13+
testing directory is structured to differentiate tests to their applicability,
14+
for example an interface test for glibc would be found in tests/glibc and
15+
tests that address distribution concerns, such as identifying the vendor are
16+
located in tests/distro.
17+
18+
documents/problems
19+
- contains text files following the template (specification.tmpl) with
20+
a completed Problem Statement section.
21+
- the documents describe a problem that affects many or all distributions
22+
and makes it difficult to treat the distributions as one platform from
23+
an ISV developer or administrative point of view. Differences in packaging
24+
generally do not fall into this category.
25+
26+
documents/proposals
27+
- contains text files following the template (specification.tmpl) with
28+
a completed Problem Statement and a completed Proposed Solution section.
29+
- the documents describe the proposed solution to the problem statement,
30+
that will function as the starting point of a discussion in the respective
31+
distribution development communities. Links to the mailing list discussions
32+
are to be included.
33+
34+
documents/specifications
35+
- contains text files following the template (specification.tmpl) with
36+
a completed Problem Statement and a completed Solution section.
37+
- the documents describe the consensus solution to the problem statement.
38+
In most cases the "Proposed Solution" section can be renamed to
39+
"Solution". The links to the mailing list discussions during the proposal
40+
phase are to remain.
41+
- contains a list of distributions that have pledged to abide by this
42+
specification and integrate the appropriate unit test into their QA suite
43+
- contains the name(s) of the tests verifying the solution implementation.
44+
45+
tests/distro
46+
- contains tests that verify distribution level specifications, such as
47+
the identification of the distribution vendor.

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,68 @@ lsb
22
===
33

44
Linux Standard Base Documentation and Tests
5+
6+
The Linux Standard Base working group is a working group under the umbrella
7+
of the Linux Foundation.
8+
9+
For many years the working group has spent it's time focusing on the
10+
production of the LSB specification which consists of a formal written
11+
specification, similar to IEEE or ISO standards, and an accompanying test
12+
suite.
13+
14+
The specification was defined as a trailing specification to document an
15+
accepted cross section of packages, libraries, and interfaces in Linux
16+
distributions, primarily focused on the Enterprise distributions. As the
17+
"Linux market" has matured the specification and tests have contributed to
18+
maintaining a certain compatibility across Linux distributions making it
19+
reasonably straight forward for ISVs to treat many distributions as one
20+
Linux platform. At the same time the demand on new interfaces and the speed
21+
at which these interfaces have been adopted by Linux distributions has
22+
significantly increased such that the creation of a formal specification
23+
and accompanying certification is no longer a tenable goal. Therefore,
24+
at the face to face meeting held during the Linux Foundation Collaboration
25+
Summit in March, 2014, the working group has concluded that rather than
26+
producing a voluminous specification the working group should transform it's
27+
work to become the place to discuss and resolve cross-distribution topics
28+
that are important to ISVs and distributors. This new approach will allow the
29+
working group to continue to provide the value of contributing to distribution
30+
compatibility while at the same time being more involved in cross-distribution
31+
discussions.
32+
33+
The LSB 5.0 specification released in 2014 will be the last of it's kind. The
34+
specification and tests are in maintenance mode. Bugs will be accepted and
35+
fixed and these bug fixes may be released as updates, i.e. 5.0.1 and others
36+
as needed. However, there is no ongoing work to produce a new LSB 5.1 or 6.0
37+
specification. The specification and accompanying tests remain in the Bazaar
38+
tree (http://bzr.linuxfoundation.org/loggerhead/lsb/) maintained by the
39+
working group. No new development, i.e. addition of interfaces, libraries,
40+
etc. is expected in the Bazaar repository.
41+
42+
The focus on providing distribution compatibility, where its matters to
43+
distributions, ISVs, and other stakeholders will remain a key goal of the
44+
working group. The approach to the compatibility challenge is that a specific
45+
challenge will be described in a reasonably short document along with a
46+
solution. Once a solution is accepted by a number of distributions it becomes
47+
a de facto standard. Where ever possible one or more tests are to be
48+
implemented that allow distributions to test their compliance to the agreed
49+
upon specification.
50+
51+
The general work flow is that a problem is identified and the problem
52+
statement is formulated. The working copy of the problem statement is tracked
53+
in documents/problems. Once a solution statement has been formulated the
54+
document migrates from documents/problems to documents/proposals. The proposal
55+
should be vetted on distribution mailing lists and the discussion should be
56+
included by reference link to the archive in the proposal. After a consensus
57+
is reached and implementation can commence the proposal becomes a de facto
58+
standard and migrates to documents/specifications. Unless specifically stated
59+
no document should become an accepted specification without an accompanying
60+
test that allows distributions to self monitor their compliance to the
61+
agreed upon de facto standard. An accepted specification contains a list
62+
of distributions that have pledged to meet the specification and have pledged
63+
to integrate the appropriate test in their distribution test suite.
64+
65+
Contribution guidelines are provided in the Contributing.txt file in the
66+
top level of the repository.
67+
68+
69+

specification.tmpl

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
LSB Specification
2+
3+
Problem Statement:
4+
------------------
5+
6+
Add the problem statement that affects multiple or all distributions here.
7+
Explain in detail how the observed problem negatively impacts ISVs or
8+
distributions by having divergent behavior between the distributions.
9+
10+
11+
(Proposed) Solution:
12+
--------------------
13+
14+
Add a detailed description of the proposed solution in this section. Detailed
15+
implementation suggestions are welcome. Be as specific as possible to provide
16+
a good technical basis for discussion on the various distribution mailing
17+
lists.
18+
19+
Solution Discussion Links:
20+
--------------------------
21+
22+
Provide links to at least 3 distribution mailing lists where this topic has
23+
been discussed.
24+
25+
26+
Solution Rational:
27+
------------------
28+
29+
Provide a brief description how the documented solution was derived.
30+
31+
32+
Distributions Support:
33+
----------------------
34+
35+
A list of distributions that have pledged to adhere to this specification and
36+
integrate the test into their QA suite.
37+
38+
39+
Verification Test:
40+
------------------
41+
42+
The list of tests that can be incorporated into distribution QA testing
43+
frameworks.

0 commit comments

Comments
 (0)