This is an archive of the discontinued LLVM Phabricator instance.

libcxx/docs/index.rst
121–124	I interpret this as saying "We say that other platforms are not formally supported, but in reality, they are kind of supported". That's exactly what I would like to steer away from, i.e. implicitly-supported-but-not-tested-platforms. I would rather keep the current "hard" stance taken by the documentation in the hopes that people will actually add CI for the configurations they care about, instead of de-incentivizing them by saying "oh but in practice other untested configurations are still supported".
127–128	You could say something like: It may happen to work, and in practice the library is known to work on some platforms not listed here, but we don't make any guarantees. If you would like your compiler and/or platform to be formally supported and listed here, please work with [...]

This revision now requires changes to proceed.Jul 13 2021, 5:48 AM

mstorsjo added inline comments.Jul 13 2021, 5:53 AM

libcxx/docs/index.rst
121–124	Trust me, I want to add CI for as many diverse configurations as practically possible, I'm not trying to shy away from that. But practicalities are a different matter...
127–128	Fair enough, that's at least some sort of acknowledgement.

Changed to Louis' suggestion.

mstorsjo retitled this revision from [libcxx] [docs] Clarify what "supported" means in this context to [libcxx] [docs] Acknowledge that the library is known to work in some configs outside of what's tested in CI.Jul 13 2021, 5:57 AM

mstorsjo edited the summary of this revision. (Show Details)

Harbormaster completed remote builds in B113719: Diff 358243.Jul 13 2021, 6:11 AM

ldionne accepted this revision.Jul 13 2021, 7:26 AM

This revision is now accepted and ready to land.Jul 13 2021, 7:26 AM

• Quuxplusone accepted this revision.Jul 13 2021, 10:58 AM

This revision was landed with ongoing or failed builds.Jul 13 2021, 1:19 PM

Closed by commit rG1c69005c2e11: [libcxx] [docs] Acknowledge that the library is known to work in some configs… (authored by mstorsjo). · Explain Why

This revision was automatically updated to reflect the committed changes.

mstorsjo added a commit: rG1c69005c2e11: [libcxx] [docs] Acknowledge that the library is known to work in some configs….

Revision Contents

Path

Size

libcxx/

docs/

index.rst

6 lines

Diff 358410

libcxx/docs/index.rst

	Show First 20 Lines • Show All 112 Lines • ▼ Show 20 Lines
	Target platform Target architecture Notes			Target platform Target architecture Notes
	=============== ========================= ============================			=============== ========================= ============================
	macOS 10.9+ i386, x86_64, arm64 Building the shared library itself requires targetting macOS 10.11+			macOS 10.9+ i386, x86_64, arm64 Building the shared library itself requires targetting macOS 10.11+
	FreeBSD 10+ i386, x86_64, arm			FreeBSD 10+ i386, x86_64, arm
	Linux i386, x86_64, arm, arm64			Linux i386, x86_64, arm, arm64
	Windows x86_64			Windows x86_64
	=============== ========================= ============================			=============== ========================= ============================

	Generally speaking, libc++ should work on any platform that provides a fairly complete			Generally speaking, libc++ should work on any platform that provides a fairly complete
	C Standard Library. It is also possible to turn off parts of the library for use on			C Standard Library. It is also possible to turn off parts of the library for use on
	systems that provide incomplete support.			systems that provide incomplete support.

				ldionneUnsubmitted Not Done Reply Inline Actions I interpret this as saying "We say that other platforms are not formally supported, but in reality, they are kind of supported". That's exactly what I would like to steer away from, i.e. implicitly-supported-but-not-tested-platforms. I would rather keep the current "hard" stance taken by the documentation in the hopes that people will actually add CI for the configurations they care about, instead of de-incentivizing them by saying "oh but in practice other untested configurations are still supported". ldionne: I interpret this as saying "We say that other platforms are not formally supported, but in…
				mstorsjoAuthorUnsubmitted Done Reply Inline Actions Trust me, I want to add CI for as many diverse configurations as practically possible, I'm not trying to shy away from that. But practicalities are a different matter... mstorsjo: Trust me, I want to add CI for as many diverse configurations as practically possible, I'm not…
	However, libc++ aims to provide a high-quality implementation of the C++ Standard			However, libc++ aims to provide a high-quality implementation of the C++ Standard
	Library, especially when it comes to correctness. As such, we aim to have test coverage			Library, especially when it comes to correctness. As such, we aim to have test coverage
	for all the platforms and compilers that we claim to support. If a platform or compiler			for all the platforms and compilers that we claim to support. If a platform or compiler
	is not listed here, it is not officially supported. It may happen to work, but we don't			is not listed here, it is not officially supported. It may happen to work, and
				ldionneUnsubmitted Not Done Reply Inline Actions You could say something like: It may happen to work, and in practice the library is known to work on some platforms not listed here, but we don't make any guarantees. If you would like your compiler and/or platform to be formally supported and listed here, please work with [...] ldionne: You could say something like: > It may happen to work, and in practice the library is known to…
				mstorsjoAuthorUnsubmitted Done Reply Inline Actions Fair enough, that's at least some sort of acknowledgement. mstorsjo: Fair enough, that's at least some sort of acknowledgement.
	make any guarantees. If you would like your compiler and/or platform to be listed here,			in practice the library is known to work on some platforms not listed here, but
				we don't make any guarantees. If you would like your compiler and/or platform
				to be formally supported and listed here,
	please work with the libc++ team to set up testing for your configuration.			please work with the libc++ team to set up testing for your configuration.


	C++ Dialect Support			C++ Dialect Support
	===================			===================

	* C++11 - Complete			* C++11 - Complete
	* :ref:`C++14 - Complete <cxx14-status>`			* :ref:`C++14 - Complete <cxx14-status>`
	▲ Show 20 Lines • Show All 80 Lines • Show Last 20 Lines

This is an archive of the discontinued LLVM Phabricator instance.

[libcxx] [docs] Acknowledge that the library is known to work in some configs outside of what's tested in CIClosedPublic

Details

Diff Detail

Event Timeline

Revision Contents

Diff 358410

libcxx/docs/index.rst

[libcxx] [docs] Acknowledge that the library is known to work in some configs outside of what's tested in CI
ClosedPublic