[PR #11090] [MERGED] DRAFT Spec for Buffer Exporting and Logging #28406

Open
opened 2026-01-31 09:28:19 +00:00 by claunia · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/microsoft/terminal/pull/11090
Author: @zadjii-msft
Created: 8/31/2021
Status: Merged
Merged: 12/13/2022
Merged by: @undefined

Base: mainHead: dev/migrie/s/642-logging


📝 Commits (6)

  • b0006f4 Write the entire exporting & logging spec
  • 85eead7 Migrate spelling-0.0.21 changes from main
  • a317d53 Merge remote-tracking branch 'origin/main' into dev/migrie/s/642-logging
  • 0dd9cbd I'm officially moving this to the drafts/ folder to clear out the PR backlog. We're not making any progress on this immediately.
  • 457e3c4 many typos
  • c9ec266 the bane of my existence

📊 Changes

6 files changed (+380 additions, -1 deletions)

View changed files

📝 .github/actions/spelling/expect/expect.txt (+0 -1)
doc/specs/drafts/#642 - Buffer Exporting and Logging/#642 - Buffer Exporting and Logging.md (+380 -0)
doc/specs/drafts/#642 - Buffer Exporting and Logging/ConEmu-logging-settings.png (+0 -0)
doc/specs/drafts/#642 - Buffer Exporting and Logging/PuTTY-logging-settings.png (+0 -0)
doc/specs/drafts/#642 - Buffer Exporting and Logging/SecureCRT-logging-settings.png (+0 -0)
doc/specs/drafts/#642 - Buffer Exporting and Logging/securecrt-context-menu.png (+0 -0)

📄 Description

doc link

Summary of the Pull Request

This is an intentionally brief spec to address the full scope of #642. The
intention of this spec is to quickly build consensus around all the features we
want for logging, and prepare an implementation plan.

Abstract

A common user need is the ability to export the history of a terminal session to
a file, for later inspection or validation. This is something that could be
triggered manually. Many terminal emulators provide the ability to automatically
log the output of a session to a file, so the history is always captured. This
spec will address improvements to the Windows Terminal to enable these kinds of
exporting and logging scenarios.

PR Checklist

Detailed Description of the Pull Request / Additional comments

*** read the spec ***

Open Discussion

  • What formatting string syntax and variables do we want to use?
  • How exactly do we want to handle "log printable output"? Do we include backspaces? Do we only log on newlines?
  • > maybe consider even simpler options like just ${date} and ${time}, and allow for future variants with something like ${date:yyyy-mm-dd} or ${time:hhmm}

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/microsoft/terminal/pull/11090 **Author:** [@zadjii-msft](https://github.com/zadjii-msft) **Created:** 8/31/2021 **Status:** ✅ Merged **Merged:** 12/13/2022 **Merged by:** [@undefined](undefined) **Base:** `main` ← **Head:** `dev/migrie/s/642-logging` --- ### 📝 Commits (6) - [`b0006f4`](https://github.com/microsoft/terminal/commit/b0006f4af24f2efb124bfdb2459999c7868a0d78) Write the entire exporting & logging spec - [`85eead7`](https://github.com/microsoft/terminal/commit/85eead768ebd7fcfbad47a191b25da308d5860d1) Migrate spelling-0.0.21 changes from main - [`a317d53`](https://github.com/microsoft/terminal/commit/a317d53d7982087e8e42078e45a95481befbb491) Merge remote-tracking branch 'origin/main' into dev/migrie/s/642-logging - [`0dd9cbd`](https://github.com/microsoft/terminal/commit/0dd9cbdacd301101ed59da2ed6e423739535a0ab) I'm officially moving this to the `drafts/` folder to clear out the PR backlog. We're not making any progress on this immediately. - [`457e3c4`](https://github.com/microsoft/terminal/commit/457e3c47e61f6252aa03acecc49db319b2e5b2ac) many typos - [`c9ec266`](https://github.com/microsoft/terminal/commit/c9ec26615cfc7564da6bbfe26a92970e46384988) the bane of my existence ### 📊 Changes **6 files changed** (+380 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `.github/actions/spelling/expect/expect.txt` (+0 -1) ➕ `doc/specs/drafts/#642 - Buffer Exporting and Logging/#642 - Buffer Exporting and Logging.md` (+380 -0) ➕ `doc/specs/drafts/#642 - Buffer Exporting and Logging/ConEmu-logging-settings.png` (+0 -0) ➕ `doc/specs/drafts/#642 - Buffer Exporting and Logging/PuTTY-logging-settings.png` (+0 -0) ➕ `doc/specs/drafts/#642 - Buffer Exporting and Logging/SecureCRT-logging-settings.png` (+0 -0) ➕ `doc/specs/drafts/#642 - Buffer Exporting and Logging/securecrt-context-menu.png` (+0 -0) </details> ### 📄 Description ### ⇒ [doc link](https://github.com/microsoft/terminal/blob/dev/migrie%2Fs%2F642-logging/doc/specs/drafts/%23642%20-%20Buffer%20Exporting%20and%20Logging/%23642%20-%20Buffer%20Exporting%20and%20Logging.md) ⇐ ## Summary of the Pull Request This is an intentionally brief spec to address the full scope of #642. The intention of this spec is to quickly build consensus around all the features we want for logging, and prepare an implementation plan. ### Abstract > A common user need is the ability to export the history of a terminal session to > a file, for later inspection or validation. This is something that could be > triggered manually. Many terminal emulators provide the ability to automatically > log the output of a session to a file, so the history is always captured. This > spec will address improvements to the Windows Terminal to enable these kinds of > exporting and logging scenarios. ## PR Checklist * [x] Specs: #642 * [x] References: #5000, #9287, #11045, #11062 * [x] I work here ## Detailed Description of the Pull Request / Additional comments _\*<sup>\*</sup><sub>\*</sub> read the spec <sub>\*</sub><sup>\*</sup>\*_ ## Open Discussion * [ ] What formatting string syntax and variables do we want to use? * [ ] How exactly do we want to handle "log printable output"? Do we include backspaces? Do we only log on newlines? * [ ] > maybe consider even simpler options like just `${date}` and `${time}`, and allow for future variants with something like `${date:yyyy-mm-dd}` or `${time:hhmm}` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-31 09:28:19 +00:00
Sign in to join this conversation.
No Label pull-request
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#28406