This is an archive of the discontinued LLVM Phabricator instance.

Spelling correction for docs for cppcoreguidelines-owning-memory
ClosedPublic

Authored by gobennyb on Mar 31 2019, 2:27 PM.

Reviewers

Commits

Summary

There's a typo in the docs, as mentioned in the title. Please see the diff.

gobennyb created this object with edit policy "Administrators".

If you have permissions on the repo, no need for a review for such change!

In D60050#1449392, @sylvestre.ledru wrote:

If you have permissions on the repo, no need for a review for such change!

I do not, so if someone could please commit for me, that'd be great. Thanks!

This revision was not accepted when it landed; it landed in state Needs Review.Mar 31 2019, 2:53 PM

This revision was automatically updated to reflect the committed changes.

Path

Size

clang-tools-extra/

trunk/

docs/

clang-tidy/

checks/

2 lines

	Show First 20 Lines • Show All 44 Lines • ▼ Show 20 Lines
	to be deleted.			to be deleted.

	.. code-block:: c++			.. code-block:: c++

	// Example Bad, non-owner as resource handle, will be caught.			// Example Bad, non-owner as resource handle, will be caught.
	int* NonOwner = new int(42); // First warning here, since new must land in an owner			int* NonOwner = new int(42); // First warning here, since new must land in an owner
	delete NonOwner; // Second warning here, since only owners are allowed to be deleted			delete NonOwner; // Second warning here, since only owners are allowed to be deleted

	// Example Good, Ownership correclty stated			// Example Good, Ownership correctly stated
	gsl::owner<int*> Owner = new int(42); // Good			gsl::owner<int*> Owner = new int(42); // Good
	delete Owner; // Good as well, statically enforced, that only owners get deleted			delete Owner; // Good as well, statically enforced, that only owners get deleted

	The check will furthermore ensure, that functions, that expect a ``gsl::owner<T*>`` as			The check will furthermore ensure, that functions, that expect a ``gsl::owner<T*>`` as
	argument get called with either a ``gsl::owner<T*>`` or a newly created resource.			argument get called with either a ``gsl::owner<T*>`` or a newly created resource.

	.. code-block:: c++			.. code-block:: c++

	▲ Show 20 Lines • Show All 115 Lines • Show Last 20 Lines