Skip to content

Commit 91ee5b0

Browse files
memshardedAbrilRBS
andauthored
cache ref feature (#4146)
* cache ref feature * Update reference/commands/cache.rst --------- Co-authored-by: Abril Rincón Blanco <5364255+AbrilRBS@users.noreply.github.com>
1 parent 7d9942e commit 91ee5b0

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

reference/commands/cache.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,3 +243,23 @@ conan cache restore
243243

244244

245245
Read more in :ref:`devops_save_restore`.
246+
247+
248+
conan cache ref
249+
----------------
250+
251+
.. autocommand::
252+
:command: conan cache ref -h
253+
254+
255+
For a given cache folder, returns the Conan reference, that is, a recipe reference in the form ``name/version#recipe_revision``, or a package reference in the form ``name/version#recipe_revision:package_id#package_revision`` (both could also have user/channel), depending on the contents of the folder.
256+
257+
This is a developer and debugging command, intended for occasional developer usage while debugging potential issues, but it is not recommended for any other use case.
258+
259+
.. note::
260+
261+
**Best practices**
262+
263+
Navigating the Conan cache is not an intended or supported use case. Using the ``conan cache ref`` command in any automation, CI or scripting
264+
is strongly discouraged.
265+
The ``conan cache ref`` is intended exclusively to be a helper command for developers while debugging.

0 commit comments

Comments
 (0)