From 22391f1f2c8ec16b63f0cd380af2a518bf354ff0 Mon Sep 17 00:00:00 2001 From: cppbear Date: Thu, 8 Oct 2026 23:00:54 +0800 Subject: [PATCH] docs: remove repository origin notes --- CONTRIBUTING.md | 2 +- README.md | 5 ++-- docs/README.md | 1 - docs/ase2025/README.md | 2 +- docs/palm-rust-unit-test-generation.md | 2 +- docs/source-integration.md | 40 -------------------------- 6 files changed, 5 insertions(+), 47 deletions(-) delete mode 100644 docs/source-integration.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f25a5ff0c5..44732dabe5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,4 +37,4 @@ Run PALM on a working copy of a target crate: preprocessing changes its source a Keep the change focused and explain the problem, resulting behavior, and checks you ran. Add a regression case for a reproduced behavior change when the existing checks do not cover it. Real-model calls are not required for ordinary fixes; use local fixtures or existing saved candidates where practical. -Keep credentials, target build directories, generated answers, coverage reports, and local trial logs out of commits. Preserve the pinned toolchain and dependency lockfile unless changing them is part of the task. Record the origin of imported code or material in [source integration notes](docs/source-integration.md), and retain its applicable notices. +Keep credentials, target build directories, generated answers, coverage reports, and local trial logs out of commits. Preserve the pinned toolchain and dependency lockfile unless changing them is part of the task. diff --git a/README.md b/README.md index cedf2ae7ce..c3733dab2a 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ Generation or repair completing does not mean every candidate passes. Inspect bo | `build-utils/` | Configure the compiler library search path during builds. | | [examples](examples/README.md) | The minimal fixture, bundled bytes target, and usage instructions. | | `docker/` | Container build and run scripts. | -| [docs](docs/README.md) | Technical guide, ASE 2025 materials, and source integration notes. | +| [docs](docs/README.md) | Technical guide, validation guides, and ASE 2025 materials. | ## Docker @@ -115,7 +115,6 @@ Bug reports and focused pull requests are welcome. See [CONTRIBUTING.md](CONTRIB - [Technical guide in Chinese](docs/palm-rust-unit-test-generation.md): architecture, data flow, and usage. - [ASE 2025 materials](docs/ase2025/README.md): the original poster and presentation. -- [Source integration notes](docs/source-integration.md): source repositories, revisions, and branch decisions. ## Citation @@ -134,4 +133,4 @@ If you use PALM in your research, please cite the ASE 2025 paper. [CITATION.cff] ## License -PALM is licensed under the [MIT License](LICENSE). The bundled [bytes example](examples/bytes/LICENSE) retains its original MIT license and copyright notice. See [source integration notes](docs/source-integration.md#licensing-and-attribution) for the origins and attribution of included code and materials. +PALM is licensed under the [MIT License](LICENSE). The bundled [bytes example](examples/bytes/LICENSE) retains its original MIT license and copyright notice. Existing third-party notices and rights in included material remain applicable. diff --git a/docs/README.md b/docs/README.md index 533e7079e5..9c1b809551 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,7 +14,6 @@ PALM's implementation, technical guide, and conference materials are available i | [bytes example](../examples/README.md) | Commands for analyzing a working copy of the bundled target. | | [utgen reference](../utgen/README.md) | Configuration, CLI behavior, and output files. | | [ASE 2025 materials](ase2025/README.md) | Original poster and presentation PDFs. | -| [Source integration notes](source-integration.md) | Repository origins and the changes selected for integration. | | [Build validation](build-validation.md) | Fixed-toolchain baseline, runtime-configuration checks, and validation limits. | The conference PDFs describe the work presented in 2025. The technical guide and command reference describe the implementation maintained here; the current code includes changes made after that presentation. diff --git a/docs/ase2025/README.md b/docs/ase2025/README.md index 07c8dcdd38..bed0fe3247 100644 --- a/docs/ase2025/README.md +++ b/docs/ase2025/README.md @@ -5,4 +5,4 @@ These are the original presentation materials for **PALM: Synergizing Program An - [Poster](research-2647-poster.pdf): one A0 page. - [Presentation](research-2647-pre.pdf): 33 pages. -Both PDFs are preserved byte for byte from [`cppbear/ase2025`, commit `d24c7d5`](https://github.com/cppbear/ase2025/tree/d24c7d5cda1604894d3b2cecfaddeecd3ef46b73). For installation and commands for the current code, see the [project README](../../README.md) and [technical guide](../palm-rust-unit-test-generation.md). +For installation and commands for the current code, see the [project README](../../README.md) and [technical guide](../palm-rust-unit-test-generation.md). diff --git a/docs/palm-rust-unit-test-generation.md b/docs/palm-rust-unit-test-generation.md index f73cdd9a8b..a23a3af9ea 100644 --- a/docs/palm-rust-unit-test-generation.md +++ b/docs/palm-rust-unit-test-generation.md @@ -2,7 +2,7 @@ 本文重点说明 PALM 的技术路线、各模块职责、数据流和运行步骤。 -下文源码路径均相对于 PALM 仓库根目录。指南与配图来自 `rust-utgen/1.87`，命令说明已按当前 PALM 实现校正；版本与整合范围见[来源记录](source-integration.md)，会议展示材料见 [ASE 2025 资料](ase2025/README.md)。 +下文源码路径均相对于 PALM 仓库根目录，命令说明对应当前 PALM 实现。会议展示材料见 [ASE 2025 资料](ase2025/README.md)。 ## 1. 项目目标 diff --git a/docs/source-integration.md b/docs/source-integration.md deleted file mode 100644 index d6a8170b1f..0000000000 --- a/docs/source-integration.md +++ /dev/null @@ -1,40 +0,0 @@ -# Source Integration - -This repository brings together PALM's implementation, the technical guide developed in `rust-utgen`, and the ASE 2025 presentation materials. The implementation baseline is [`cppbear/PALM`, commit `60572e3`](https://github.com/cppbear/PALM/tree/60572e367faad7603878d61fcc1d02344f810774). - -## Source Revisions - -| Repository and branch | Revision | Treatment | -| --- | --- | --- | -| `cppbear/PALM`, `main` | `60572e367faad7603878d61fcc1d02344f810774` | Preserve the implementation and promote the contents of `palm/` to the repository root. | -| `SSCT-Lab/rust-utgen`, `main` | `3807fbe8b69bdb0c7206bdf7b4f538d252be3b4e` | Its main generation updates are already represented in the PALM baseline. | -| `SSCT-Lab/rust-utgen`, `1.87` | `4de8a5994052eb680beb6f773c9a80299ce7be58` | Import the Chinese guide and eight images from `docs/`; adjust the guide to describe PALM's current behavior. | -| `SSCT-Lab/rust-utgen`, `comment_out_test_module` | `29b8377ec9af251b4cb3795c7582c6d8673c6c22` | Retain PALM's existing handling of both test modules and test functions. | -| `SSCT-Lab/rust-utgen`, `focxt_rustc_api` | `0354152adf631987f8fa0a68d80567a6522f669f` | Leave the experimental context extractor in its source branch. | -| `cppbear/ase2025`, `main` | `d24c7d5cda1604894d3b2cecfaddeecd3ef46b73` | Import both original PDFs into `docs/ase2025/`. | - -The source repositories have separate Git histories. Selected files are imported with their origins recorded here; this integration does not merge those histories or remove the source repositories. - -## Licensing and Attribution - -PALM's source code, scripts, and project documentation use the root [MIT License](../LICENSE), with collective attribution to PALM contributors. The five tool crates declare the same license through workspace metadata. The selected source revisions above did not contain a license for the PALM implementation; this repository now explicitly adopts MIT rather than inheriting the example crate's license. - -The bundled `examples/bytes` crate retains its [original MIT license and copyright notice](../examples/bytes/LICENSE). The technical guide and images originate from `rust-utgen`; the conference PDFs originate from `ase2025` and are preserved as described in [ASE 2025 materials](ase2025/README.md). Existing third-party notices and rights in included material remain applicable; the root license does not replace them. - -## Layout and Compatibility - -The Rust workspace, installation script, and Docker scripts now reside at the repository root. The two original README files are consolidated, and the root `.gitignore` retains all original rules, including `api.json`. - -The initial integration preserved Rust source files, prompt templates, executable permissions, the pinned `nightly-2025-03-19` toolchain, and `Cargo.lock` from the PALM baseline. All five tool crates remain workspace members. The root workspace explicitly excludes `examples/bytes`, allowing that target to be used as a separate Cargo workspace. - -The existing container mount point remains `/home/palm/palm`. Commands in the project documentation start from the new repository root or an explicitly identified target directory. - -## Branch Decisions - -The `1.87` branch's compiler API changes and Rust 2024 edition migration are already present in the PALM baseline. Its guide and eight images are the added documentation assets. The images are preserved byte for byte; the guide is revised for portable example paths, current preprocessing behavior, CLI limitations, and output locations. - -The `comment_out_test_module` branch only handles test modules. PALM already handles modules as well as standalone test functions and namespaced test attributes, so replacing its preprocessor with that branch would remove existing behavior. Further preprocessor corrections are a separate change. - -The `focxt_rustc_api` branch changes the entry point to `cargo focxt` and produces `focxt/name_map.json`, while its generation code still requires `focxt/impl_informations.json`. It also uses the older compiler API. Integration of that extractor requires a separate interface migration and validation. - -The integration commits preserved the existing generation and repair behavior. Subsequent maintenance adds runtime API configuration, isolates real-model tests, and validates installation and basic CI; see [build validation](build-validation.md). Subsequent checks cover [function-level task limits](minimal-pipeline.md#task-scheduling-regression) and [bytes analysis](bytes-analysis.md). The unfinished batch test injection path remains outside the active CLI.