2 lines
12 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>ResultsDirEntryName (infer.IBase.ResultsDirEntryName)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">infer</a> &#x00BB; <a href="../index.html">IBase</a> &#x00BB; ResultsDirEntryName</nav><h1>Module <code>IBase.ResultsDirEntryName</code></h1></header><aside><p>Entries in the results directory (infer-out/). Unless you want to specify a custom results directory you probably want to use <span class="xref-unresolved" title="unresolved reference to &quot;ResultsDir.Entry&quot;"><a href="../index.html#module-ResultsDir"><code>ResultsDir</code></a>.Entry</span> instead of this module.</p></aside><dl><dt class="spec type" id="type-id"><a href="#type-id" class="anchor"></a><code><span class="keyword">type</span> id</code><code> = </code><table class="variant"><tr id="type-id.AllocationTraces" class="anchored"><td class="def constructor"><a href="#type-id.AllocationTraces" class="anchor"></a><code>| </code><code><span class="constructor">AllocationTraces</span></code></td><td class="doc"><p>directory for storing allocation traces</p></td></tr><tr id="type-id.CaptureDB" class="anchored"><td class="def constructor"><a href="#type-id.CaptureDB" class="anchor"></a><code>| </code><code><span class="constructor">CaptureDB</span></code></td><td class="doc"><p>the capture database</p></td></tr><tr id="type-id.CaptureDBShm" class="anchored"><td class="def constructor"><a href="#type-id.CaptureDBShm" class="anchor"></a><code>| </code><code><span class="constructor">CaptureDBShm</span></code></td><td class="doc"><p>SQLite-generated index file for the capture database's write-ahead log</p></td></tr><tr id="type-id.CaptureDBWal" class="anchored"><td class="def constructor"><a href="#type-id.CaptureDBWal" class="anchor"></a><code>| </code><code><span class="constructor">CaptureDBWal</span></code></td><td class="doc"><p>the capture database's write-ahead log generated by SQLite</p></td></tr><tr id="type-id.CaptureDependencies" class="anchored"><td class="def constructor"><a href="#type-id.CaptureDependencies" class="anchor"></a><code>| </code><code><span class="constructor">CaptureDependencies</span></code></td><td class="doc"><p>list of infer-out/ directories that contain capture artefacts</p></td></tr><tr id="type-id.ChangedFunctions" class="anchored"><td class="def constructor"><a href="#type-id.ChangedFunctions" class="anchor"></a><code>| </code><code><span class="constructor">ChangedFunctions</span></code></td><td class="doc"><p>results of the clang test determinator</p></td></tr><tr id="type-id.Debug" class="anchored"><td class="def constructor"><a href="#type-id.Debug" class="anchor"></a><code>| </code><code><span class="constructor">Debug</span></code></td><td class="doc"><p>directory containing debug data</p></td></tr><tr id="type-id.Differential" class="anchored"><td class="def constructor"><a href="#type-id.Differential" class="anchor"></a><code>| </code><code><span class="constructor">Differential</span></code></td><td class="doc"><p>contains the results of <code>infer reportdiff</code></p></td></tr><tr id="type-id.DuplicateFunctions" class="anchored"><td class="def constructor"><a href="#type-id.DuplicateFunctions" class="anchor"></a><code>| </code><code><span class="constructor">DuplicateFunctions</span></code></td><td class="doc"><p>list of duplicated functions</p></td></tr><tr id="type-id.JavaClassnamesCache" class="anchored"><td class="def constructor"><a href="#type-id.JavaClassnamesCache" class="anchor"></a><code>| </code><code><span class="constructor">JavaClassnamesCache</span></code></td><td class="doc"><p>used when capturing Java jar dependencies</p></td></tr><tr id="type-id.JavaGlobalTypeEnvironment" class="anchored"><td class="def constructor"><a href="#type-id.JavaGlobalTypeEnvironment" class="anchor"></a><code>| </code><code><span class="constructor">JavaGlobalTypeEnvironment</span></code></td><td class="doc"><p>internal <span class="xref-unresolved" title="unresolved reference to &quot;Tenv.t&quot;"><code>Tenv</code>.t</span> object corresponding to the whole project</p></td></tr><tr id="type-id.LintDotty" class="anchored"><td class="def constructor"><a href="#type-id.LintDotty" class="anchor"></a><code>| </code><code><span class="constructor">LintDotty</span></code></td><td class="doc"><p>directory of linters' dotty debug output for CTL evaluation</p></td></tr><tr id="type-id.LintIssues" class="anchored"><td class="def constructor"><a href="#type-id.LintIssues" class="anchor"></a><code>| </code><code><span class="constructor">LintIssues</span></code></td><td class="doc"><p>directory of linters' issues</p></td></tr><tr id="type-id.Logs" class="anchored"><td class="def constructor"><a href="#type-id.Logs" class="anchor"></a><code>| </code><code><span class="constructor">Logs</span></code></td><td class="doc"><p>log file</p></td></tr><tr id="type-id.NullsafeFileIssues" class="anchored"><td class="def constructor"><a href="#type-id.NullsafeFileIssues" class="anchor"></a><code>| </code><code><span class="constructor">NullsafeFileIssues</span></code></td><td class="doc"><p>file-wide issues of the nullsafe analysis</p></td></tr><tr id="type-id.PerfEvents" class="anchored"><td class="def constructor"><a href="#type-id.PerfEvents" class="anchor"></a><code>| </code><code><span class="constructor">PerfEvents</span></code></td><td class="doc"><p>file containing events for performance profiling</p></td></tr><tr id="type-id.ProcnamesLocks" class="anchored"><td class="def constructor"><a href="#type-id.ProcnamesLocks" class="anchor"></a><code>| </code><code><span class="constructor">ProcnamesLocks</span></code></td><td class="doc"><p>directory of per-<span class="xref-unresolved" title="unresolved reference to &quot;Procname.t&quot;"><code>Procname</code>.t</span> file locks, used by the analysis scheduler in certain modes</p></td></tr><tr id="type-id.RacerDIssues" class="anchored"><td class="def constructor"><a href="#type-id.RacerDIssues" class="anchor"></a><code>| </code><code><span class="constructor">RacerDIssues</span></code></td><td class="doc"><p>directory of issues reported by the RacerD analysis</p></td></tr><tr id="type-id.ReportConfigImpactJson" class="anchored"><td class="def constructor"><a href="#type-id.ReportConfigImpactJson" class="anchor"></a><code>| </code><code><span class="constructor">ReportConfigImpactJson</span></code></td><td class="doc"><p>reports of the config impact analysis</p></td></tr><tr id="type-id.ReportCostsJson" class="anchored"><td class="def constructor"><a href="#type-id.ReportCostsJson" class="anchor"></a><code>| </code><code><span class="constructor">ReportCostsJson</span></code></td><td class="doc"><p>reports of the costs analysis</p></td></tr><tr id="type-id.ReportHtml" class="anchored"><td class="def constructor"><a href="#type-id.ReportHtml" class="anchor"></a><code>| </code><code><span class="constructor">ReportHtml</span></code></td><td class="doc"><p>directory of the HTML report</p></td></tr><tr id="type-id.ReportJson" class="anchored"><td class="def constructor"><a href="#type-id.ReportJson" class="anchor"></a><code>| </code><code><span class="constructor">ReportJson</span></code></td><td class="doc"><p>the main product of the analysis: <code>report.json</code></p></td></tr><tr id="type-id.ReportText" class="anchored"><td class="def constructor"><a href="#type-id.ReportText" class="anchor"></a><code>| </code><code><span class="constructor">ReportText</span></code></td><td class="doc"><p>a human-readable textual version of <code>report.json</code></p></td></tr><tr id="type-id.ReportXML" class="anchored"><td class="def constructor"><a href="#type-id.ReportXML" class="anchor"></a><code>| </code><code><span class="constructor">ReportXML</span></code></td><td class="doc"><p>a PMD-style XML version of <code>report.json</code></p></td></tr><tr id="type-id.RetainCycles" class="anchored"><td class="def constructor"><a href="#type-id.RetainCycles" class="anchor"></a><code>| </code><code><span class="constructor">RetainCycles</span></code></td><td class="doc"><p>directory of retain cycles dotty files</p></td></tr><tr id="type-id.RunState" class="anchored"><td class="def constructor"><a href="#type-id.RunState" class="anchor"></a><code>| </code><code><span class="constructor">RunState</span></code></td><td class="doc"><p>internal data about the last infer run</p></td></tr><tr id="type-id.StarvationIssues" class="anchored"><td class="def constructor"><a href="#type-id.StarvationIssues" class="anchor"></a><code>| </code><code><span class="constructor">StarvationIssues</span></code></td><td class="doc"><p>directory of issues reported by the starvation analysis</p></td></tr><tr id="type-id.Temporary" class="anchored"><td class="def constructor"><a href="#type-id.Temporary" class="anchor"></a><code>| </code><code><span class="constructor">Temporary</span></code></td><td class="doc"><p>directory containing temp files</p></td></tr><tr id="type-id.TestDeterminatorReport" class="anchored"><td class="def constructor"><a href="#type-id.TestDeterminatorReport" class="anchor"></a><code>| </code><code><span class="constructor">TestDeterminatorReport</span></code></td><td class="doc"><p>the report produced by the test determinator capture mode</p></td></tr><tr id="type-id.TestDeterminatorTempResults" class="anchored"><td class="def constructor"><a href="#type-id.TestDeterminatorTempResults" class="anchor"></a><code>| </code><code><span class="constructor">TestDeterminatorTempResults</span></code></td><td class="doc"><p>a directory</p></td></tr></table></dt></dl><dl><dt class="spec value" id="val-get_path"><a href="#val-get_path" class="anchor"></a><code><span class="keyword">val</span> get_path : <span>results_dir:string</span> <span>&#45;&gt;</span> <a href="index.html#type-id">id</a> <span>&#45;&gt;</span> string</code></dt><dd><p>the absolute path for the given entry</p></dd></dl><dl><dt class="spec value" id="val-get_issues_directories"><a href="#val-get_issues_directories" class="anchor"></a><code><span class="keyword">val</span> get_issues_directories : unit <span>&#45;&gt;</span> <span><a href="index.html#type-id">id</a> list</span></code></dt><dd><p>all the entries that correspond to directories containing temporary issue logs for certain analyses</p></dd></dl><dl><dt class="spec value" id="val-to_delete_before_incremental_capture_and_analysis"><a href="#val-to_delete_before_incremental_capture_and_analysis" class="anchor"></a><code><span class="keyword">val</span> to_delete_before_incremental_capture_and_analysis : <span>results_dir:string</span> <span>&#45;&gt;</span> <span>string list</span></code></dt><dd><p>utility for <a href="../ResultsDir/index.html#val-scrub_for_incremental"><code>ResultsDir.scrub_for_incremental</code></a>, you probably want to use that instead</p></dd></dl><dl><dt class="spec value" id="val-to_delete_before_caching_capture"><a href="#val-to_delete_before_caching_capture" class="anchor"></a><code><span class="keyword">val</span> to_delete_before_caching_capture : <span>results_dir:string</span> <span>&#45;&gt;</span> <span>string list</span></code></dt><dd><p>utility for <a href="../ResultsDir/index.html#val-scrub_for_caching"><code>ResultsDir.scrub_for_caching</code></a>, you probably want to use that instead</p></dd></dl><dl><dt class="spec value" id="val-buck_infer_deps_file_name"><a href="#val-buck_infer_deps_file_name" class="anchor"></a><code><span class="keyword">val</span> buck_infer_deps_file_name : string</code></dt><dd><p>sad that we have to have this here but some code path is looking for all files with that name in buck-out/</p></dd></dl></div></body></html>