Skip to content

An "introduction" clause #6271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tkoeppe opened this issue Jun 12, 2023 · 6 comments
Open

An "introduction" clause #6271

tkoeppe opened this issue Jun 12, 2023 · 6 comments

Comments

@tkoeppe
Copy link
Contributor

tkoeppe commented Jun 12, 2023

An optional "Introduction" clause is allowed by ISO and can be used to explain "how to read the document". We should explain our use of stable labels there, and we can move the current 4.2 [intro.structure] and 4.3 [syntax] thither.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Jun 12, 2023

"It seemed like a good idea."

@JohelEGP
Copy link
Contributor

The specifics of the required structure are at https://www.iso.org/sites/directives/current/part2/index.xhtml#_idTextAnchor169.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Feb 11, 2025

Ideas:

  • [intro.structure] could move to the introduction
  • [intro.syntax] likewise

Update from the published IS wording.

Then [intro.compliance] becomes a Clause.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Feb 11, 2025

Todo: create some novel, introductory wording:

  • one paragraph about the intended audiences
  • we once had an "acknowledgements" section; we could try to bring that back here.

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Feb 11, 2025

Another thing we could discuss: meaning of "recommended practice"

@tkoeppe
Copy link
Contributor Author

tkoeppe commented Feb 11, 2025

Regarding Acknowledgements, @AlisdairM sent:

"""
Acknowledgements from C++98

1 The C++ programming language as described in this International Standard is based on the language as
described in Chapter R (Reference Manual) of Stroustrup: The C++ Programming Language (second edi-
tion, Addison-Wesley Publishing Company, ISBN 0– 201– 53992– 6, copyright © 1991 AT&T). That, in
turn, is based on the C programming language as described in Appendix A of Kernighan and Ritchie: The C
Programming Language (Prentice-Hall, 1978, ISBN 0– 13– 110163– 3, copyright © 1978 AT&T).

2 Portions of the library clauses of this International Standard are based on work by P.J. Plauger, which was
published as The Draft Standard C++ Library (Prentice-Hall, ISBN 0– 13– 117003– 1, copyright © 1995
P.J. Plauger).

3 All rights in these originals are reserved.
"""

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants