<feed xmlns='http://www.w3.org/2005/Atom'>
<title>delta/cmake.git/Help/index.rst, branch master</title>
<subtitle>gitlab.kitware.com: cmake/cmake.git
</subtitle>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/cmake.git/'/>
<entry>
<title>ConfigureLog: Add infrastructure for structured configure event logging</title>
<updated>2022-12-16T15:11:37+00:00</updated>
<author>
<name>Matthew Woehlke</name>
<email>matthew.woehlke@kitware.com</email>
</author>
<published>2022-11-23T22:02:22+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/cmake.git/commit/?id=746c776caf1207049922edb3ea63586b94fca4c6'/>
<id>746c776caf1207049922edb3ea63586b94fca4c6</id>
<content type='text'>
Add infrastructure for a "configure log".  Use YAML for a balance of
machine- and human-readability to records details of configure-time
events in a structured format.

Teach the RunCMake test framework to support matching the configure log.

Issue: #23200
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Add infrastructure for a "configure log".  Use YAML for a balance of
machine- and human-readability to records details of configure-time
events in a structured format.

Teach the RunCMake test framework to support matching the configure log.

Issue: #23200
</pre>
</div>
</content>
</entry>
<entry>
<title>Help: Move CMakePresets.json documentation into a separate file</title>
<updated>2020-10-19T14:25:57+00:00</updated>
<author>
<name>Kyle Edwards</name>
<email>kyle.edwards@kitware.com</email>
</author>
<published>2020-10-14T19:03:07+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/cmake.git/commit/?id=c436aaaad14406916185c06fe0554d53130b5483'/>
<id>c436aaaad14406916185c06fe0554d53130b5483</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Help: Add IDE integration guide</title>
<updated>2020-10-06T15:54:12+00:00</updated>
<author>
<name>Kyle Edwards</name>
<email>kyle.edwards@kitware.com</email>
</author>
<published>2020-09-29T19:04:57+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/cmake.git/commit/?id=6e10518cbcf810ba6b42bc3f1014c72d75897a85'/>
<id>6e10518cbcf810ba6b42bc3f1014c72d75897a85</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Help: Add Importing and Exporting Guide</title>
<updated>2020-09-11T12:50:52+00:00</updated>
<author>
<name>Betsy McPhail</name>
<email>betsy.mcphail@kitware.com</email>
</author>
<published>2020-08-03T21:25:12+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/cmake.git/commit/?id=3310801aabbdcd32f82433fbd04237a1ab1744d4'/>
<id>3310801aabbdcd32f82433fbd04237a1ab1744d4</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Help: Add guides for user interaction</title>
<updated>2020-01-13T16:04:55+00:00</updated>
<author>
<name>Stephen Kelly</name>
<email>steveire@gmail.com</email>
</author>
<published>2019-11-28T15:33:27+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/cmake.git/commit/?id=bd681fee7a0f0fb95af4a71255774b52f9ea26da'/>
<id>bd681fee7a0f0fb95af4a71255774b52f9ea26da</id>
<content type='text'>
Add some prose to the documentation index page to guide readers to the
major manuals and guides.

Add a new "User Interaction Guide" to help the class of new user
who wishes to build a project with CMake for the first time, such as
after cloning a repo from a git repository.

Add a new "Using Dependencies Guide" to help the class of new
user who wishes to consume a SDK provided by a third party and needs a
starting point.  This is a different type of user to the user who wishes
to create their own project from scratch (addressed by the
`cmake-buildsystem(7)` manual) as each will encounter needs for
information discovery in a different order.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Add some prose to the documentation index page to guide readers to the
major manuals and guides.

Add a new "User Interaction Guide" to help the class of new user
who wishes to build a project with CMake for the first time, such as
after cloning a repo from a git repository.

Add a new "Using Dependencies Guide" to help the class of new
user who wishes to consume a SDK provided by a third party and needs a
starting point.  This is a different type of user to the user who wishes
to create their own project from scratch (addressed by the
`cmake-buildsystem(7)` manual) as each will encounter needs for
information discovery in a different order.
</pre>
</div>
</content>
</entry>
<entry>
<title>Help: Restore installation of top-level index</title>
<updated>2019-08-19T15:41:32+00:00</updated>
<author>
<name>Brad King</name>
<email>brad.king@kitware.com</email>
</author>
<published>2019-08-19T15:41:32+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/cmake.git/commit/?id=d56a4b16ca6f09d099c2ec832b11708f9b4b9819'/>
<id>d56a4b16ca6f09d099c2ec832b11708f9b4b9819</id>
<content type='text'>
We removed installation of `Help/index.rst` in commit d2fde94809 (Help:
Add infrastructure for guide-level documentation, 2019-05-30), but the
file is required for `--help-full` to work.  Restore installation of the
file and update it to avoid referencing the `Help/guide` directory in
its toctree during processing by `cmRST`.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
We removed installation of `Help/index.rst` in commit d2fde94809 (Help:
Add infrastructure for guide-level documentation, 2019-05-30), but the
file is required for `--help-full` to work.  Restore installation of the
file and update it to avoid referencing the `Help/guide` directory in
its toctree during processing by `cmRST`.
</pre>
</div>
</content>
</entry>
<entry>
<title>Help: Add infrastructure for guide-level documentation</title>
<updated>2019-06-18T14:36:16+00:00</updated>
<author>
<name>Brad King</name>
<email>brad.king@kitware.com</email>
</author>
<published>2019-05-30T16:25:39+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/cmake.git/commit/?id=d2fde9480955cf2246519357e01ab5142a067efc'/>
<id>d2fde9480955cf2246519357e01ab5142a067efc</id>
<content type='text'>
Create a `Help/guide/` directory to hold guide-level documents.
Build them in most documentation formats, but not as man pages.

Initialize the guide directory with a placeholder for the tutorial.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Create a `Help/guide/` directory to hold guide-level documents.
Build them in most documentation formats, but not as man pages.

Initialize the guide directory with a placeholder for the tutorial.
</pre>
</div>
</content>
</entry>
<entry>
<title>fileapi: Add protocol v1 infrastructure with support for shared query files</title>
<updated>2018-12-12T11:39:30+00:00</updated>
<author>
<name>Brad King</name>
<email>brad.king@kitware.com</email>
</author>
<published>2018-09-13T12:18:22+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/cmake.git/commit/?id=eb2ec41a0422e9acd4961e32f6f28c20846a292a'/>
<id>eb2ec41a0422e9acd4961e32f6f28c20846a292a</id>
<content type='text'>
Add a file-based API that clients may use to get semantic information
about the buildsystem that CMake generates.  Clients will write query
files under a designated location in the build tree, and CMake will
write reply files for clients to read.

Start with support for shared stateless query files.  These allow
clients to share requests for major object versions and get all those
recognized by CMake.  Once any client has written a shared request to a
build tree it will persist.  Other clients will not need to overwrite
the request (since it is stateless) and should not remove it either.

For now we add only an undocumented object kind to use for testing the
query and reply infrastructure.  Object kinds providing real semantic
information will be added later.

Issue: #18398
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Add a file-based API that clients may use to get semantic information
about the buildsystem that CMake generates.  Clients will write query
files under a designated location in the build tree, and CMake will
write reply files for clients to read.

Start with support for shared stateless query files.  These allow
clients to share requests for major object versions and get all those
recognized by CMake.  Once any client has written a shared request to a
build tree it will persist.  Other clients will not need to overwrite
the request (since it is stateless) and should not remove it either.

For now we add only an undocumented object kind to use for testing the
query and reply infrastructure.  Object kinds providing real semantic
information will be added later.

Issue: #18398
</pre>
</div>
</content>
</entry>
<entry>
<title>Help: Add new section for CPack generators</title>
<updated>2018-06-21T15:00:25+00:00</updated>
<author>
<name>Kyle Edwards</name>
<email>kyle.edwards@kitware.com</email>
</author>
<published>2018-06-15T17:20:45+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/cmake.git/commit/?id=2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a'/>
<id>2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a</id>
<content type='text'>
The documentation for CPack generators previously lived in their
respective internal CMake modules. This setup was misleading,
because it implied that you should include the modules in your own
code, which is not the case. Moving the documentation into a
separate section does a better job of hiding the internal modules,
which are just an implementation detail. The generator documentation
has also been modified to remove any references to the module name.

The CPackIFW module is a special exception: since it has user-facing
macros, the documentation for these macros has been kept in the module
page, while all other documentation related to the IFW generator has
been moved into the new section.

To make it easier to find the new documentation, the old help pages
for the CPack*.cmake modules have not been deleted, but have been
replaced with a link to their respective help page in the new
documentation section.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
The documentation for CPack generators previously lived in their
respective internal CMake modules. This setup was misleading,
because it implied that you should include the modules in your own
code, which is not the case. Moving the documentation into a
separate section does a better job of hiding the internal modules,
which are just an implementation detail. The generator documentation
has also been modified to remove any references to the module name.

The CPackIFW module is a special exception: since it has user-facing
macros, the documentation for these macros has been kept in the module
page, while all other documentation related to the IFW generator has
been moved into the new section.

To make it easier to find the new documentation, the old help pages
for the CPack*.cmake modules have not been deleted, but have been
replaced with a link to their respective help page in the new
documentation section.
</pre>
</div>
</content>
</entry>
<entry>
<title>Help: move DESTDIR into a separate page</title>
<updated>2018-04-20T12:39:02+00:00</updated>
<author>
<name>Kyle Edwards</name>
<email>kyle.edwards@kitware.com</email>
</author>
<published>2018-04-20T12:38:00+00:00</published>
<link rel='alternate' type='text/html' href='http://trove.baserock.org/cgit/delta/cmake.git/commit/?id=fcf64866dad8ce239382df5d6fde01f90ccc7e63'/>
<id>fcf64866dad8ce239382df5d6fde01f90ccc7e63</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
</feed>
