Skip to main content
CenXiv.org
This website is in trial operation, support us!
We gratefully acknowledge support from all contributors.
Contribute
Donate
cenxiv logo > cs > arXiv:2510.09073

Help | Advanced Search

Computer Science > Software Engineering

arXiv:2510.09073 (cs)
[Submitted on 10 Oct 2025 ]

Title: Literate Tracing

Title: 文献追踪

Authors:Matthew Sotoudeh
Abstract: As computer systems grow ever larger and more complex, a crucial task in software development is for one person (the system expert) to communicate to another (the system novice) how a certain program works. This paper reports on the author's experiences with a paradigm for program documentation that we call literate tracing. A literate trace explains a software system using annotated, concrete execution traces of the system. Literate traces complement both in-code comments (which often lack global context) and out-of-band design docs (which often lack a concrete connection to the code). We also describe TReX, our tool for making literate traces that are interactive, visual, and guaranteed by construction to be faithful to the program semantics. We have used TReX to write literate traces explaining components of large systems software including the Linux kernel, Git source control system, and GCC compiler.
Abstract: 随着计算机系统变得越来越大和复杂,软件开发中的一个关键任务是让一个人(系统专家)向另一个人(系统新手)解释某个程序是如何工作的。 本文报告了作者在一种称为“文学追踪”的程序文档范式方面的经验。 文学追踪使用系统注释的具体执行跟踪来解释软件系统。 文学追踪补充了代码中的注释(这些注释通常缺乏全局上下文)以及非带设计文档(这些文档通常与代码缺乏具体的联系)。 我们还描述了TReX,我们用于生成交互式、可视化且通过构造保证与程序语义一致的文学追踪的工具。 我们已经使用TReX编写了解释大型系统软件组件的文学追踪,包括Linux内核、Git源代码控制系统和GCC编译器。
Comments: examples at https://lair.masot.net/trex . SPLASH Onward 2025
Subjects: Software Engineering (cs.SE) ; Programming Languages (cs.PL)
Cite as: arXiv:2510.09073 [cs.SE]
  (or arXiv:2510.09073v1 [cs.SE] for this version)
  https://doi.org/10.48550/arXiv.2510.09073
arXiv-issued DOI via DataCite

Submission history

From: Matthew Sotoudeh [view email]
[v1] Fri, 10 Oct 2025 07:17:51 UTC (346 KB)
Full-text links:

Access Paper:

    View a PDF of the paper titled
  • View Chinese PDF
  • View PDF
  • HTML (experimental)
  • TeX Source
view license
Current browse context:
cs.SE
< prev   |   next >
new | recent | 2025-10
Change to browse by:
cs
cs.PL

References & Citations

  • NASA ADS
  • Google Scholar
  • Semantic Scholar
a export BibTeX citation Loading...

BibTeX formatted citation

×
Data provided by:

Bookmark

BibSonomy logo Reddit logo

Bibliographic and Citation Tools

Bibliographic Explorer (What is the Explorer?)
Connected Papers (What is Connected Papers?)
Litmaps (What is Litmaps?)
scite Smart Citations (What are Smart Citations?)

Code, Data and Media Associated with this Article

alphaXiv (What is alphaXiv?)
CatalyzeX Code Finder for Papers (What is CatalyzeX?)
DagsHub (What is DagsHub?)
Gotit.pub (What is GotitPub?)
Hugging Face (What is Huggingface?)
Papers with Code (What is Papers with Code?)
ScienceCast (What is ScienceCast?)

Demos

Replicate (What is Replicate?)
Hugging Face Spaces (What is Spaces?)
TXYZ.AI (What is TXYZ.AI?)

Recommenders and Search Tools

Influence Flower (What are Influence Flowers?)
CORE Recommender (What is CORE?)
IArxiv Recommender (What is IArxiv?)
  • Author
  • Venue
  • Institution
  • Topic

arXivLabs: experimental projects with community collaborators

arXivLabs is a framework that allows collaborators to develop and share new arXiv features directly on our website.

Both individuals and organizations that work with arXivLabs have embraced and accepted our values of openness, community, excellence, and user data privacy. arXiv is committed to these values and only works with partners that adhere to them.

Have an idea for a project that will add value for arXiv's community? Learn more about arXivLabs.

Which authors of this paper are endorsers? | Disable MathJax (What is MathJax?)
  • About
  • Help
  • contact arXivClick here to contact arXiv Contact
  • subscribe to arXiv mailingsClick here to subscribe Subscribe
  • Copyright
  • Privacy Policy
  • Web Accessibility Assistance
  • arXiv Operational Status
    Get status notifications via email or slack

京ICP备2025123034号