From daa157abc54695fe10da98368ebea0b63c4e95e2 Mon Sep 17 00:00:00 2001 From: Thomas Walker Lynch Date: Sat, 7 Dec 2024 13:39:26 +0000 Subject: [PATCH] Updates the pencil suffix doc --- .../About_the_Pencil_Suffix.html" | 158 ++++++++++++++++++ "document\360\237\226\211/pencil_suffix.html" | 110 ------------ env_developer | 1 + env_devloper | 1 - .../document\360\237\226\211/make_rm_na.txt" | 17 ++ 5 files changed, 176 insertions(+), 111 deletions(-) create mode 100644 "document\360\237\226\211/About_the_Pencil_Suffix.html" delete mode 100644 "document\360\237\226\211/pencil_suffix.html" create mode 120000 env_developer delete mode 120000 env_devloper create mode 100644 "tool_shared/document\360\237\226\211/make_rm_na.txt" diff --git "a/document\360\237\226\211/About_the_Pencil_Suffix.html" "b/document\360\237\226\211/About_the_Pencil_Suffix.html" new file mode 100644 index 0000000..1e55c36 --- /dev/null +++ "b/document\360\237\226\211/About_the_Pencil_Suffix.html" @@ -0,0 +1,158 @@ + + + + + + + Pencil Attribute in Directory Structure + + + +
+

About The Pencil Suffix

+ +

The 🖉 (pencil) symbol suffix indicates directories or files containing authored content—material that has been uniquely created, whether by human or AI, and cannot be regenerated or replaced by running project build scripts. +Such files are called authored files. +

+ +

How to Use the Pencil Suffix

+ + + +

Nuances with Links

+ + + +

rm_na: Command to Prevent Deletion of Authored Content

+ + +

The Pencil Suffix and Editing: A Subtle but Important Distinction

+ +

The pencil suffix is often intuitively associated with "editability" because of the pencil’s traditional connotation with writing or modification. However, while related, the pencil suffix has a more nuanced and specific role in the context of our projects.

+ +

The pencil suffix indicates that a file or directory is authored content, created by a person (human or AI) and intended to be retained as part of the project. It signals that the file should not be deleted by build scripts, clean scripts, or accidental invocations of rm commands. In this way, the pencil suffix protects the content from being overwritten or discarded during routine project workflows.

+ +

The pencil suffix does not inherently restrict or permit editing. A file with the suffix can still be edited, just like any other file, as long as the operating system permissions allow it. Conversely, a file without the pencil suffix can also be edited, but its contents may be at risk of being overwritten or lost during builds or cleans.

+ +

For teams, the pencil suffix serves as a communication tool. It helps team members recognize files that are authored and can not be replaced by auto generation."

+ +

In the future, the pencil suffix could potentially evolve into a broader indicator encompassing editability or additional permissions. For now, its purpose remains focused on deletion protection and signaling authored content.

+ +

Goals

+ +
    +
  • + Visual Clarity: The pencil suffix provides an immediately recognizable visual cue, assisting in the organization and protection of authored content. +
  • +
  • + Team Collaboration: The pencil suffix is a communication device that expresses to other team members that a file is intended to be respected as authored contents. +
  • +
+ + + diff --git "a/document\360\237\226\211/pencil_suffix.html" "b/document\360\237\226\211/pencil_suffix.html" deleted file mode 100644 index 5675897..0000000 --- "a/document\360\237\226\211/pencil_suffix.html" +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - Pencil Attribute in Directory Structure - - - -
-

Pencil Suffix

-

- The 🖉 (pencil) symbol suffix is used to denote directories or files that - contain authored content. Authored content in this context refers to - files that cannot be regenerated or replaced by running a build tool. - These are typically original creations, whether by human or AI, and are - critical to retain unchanged unless explicitly modified by an author. -

- -

Implications of the Pencil Attribute

-
    -
  • Directories marked with a 🖉 are excluded from cleaning scripts or build processes that overwrite or regenerate content.
  • -
  • In the future, files or directories marked with a 🖉 will require manual editing permissions, typically managed via group ownership or specific sub-user policies.
  • -
  • In future systems using advanced access control, the 🖉 attribute could represent specific permissions where the owning sub-user can edit, while others have only read access.
  • -
- -

Future Integration

-

- This system opens a path for implementing a robust user hierarchy. For example, in a multi-user environment: -

-
    -
  • Files marked with 🖉 could be managed by a dedicated sub-user, granting specific access for editing while ensuring consistency and protection against unintended modifications.
  • -
  • The system could evolve to define "authored" attributes programmatically, enabling complex access control and file management policies across projects.
  • -
- -

Practical Usage

-

- For now, the 🖉 symbol serves as a clear and straightforward visual cue in directory names, simplifying project navigation and management. -

-
- - diff --git a/env_developer b/env_developer new file mode 120000 index 0000000..fb69647 --- /dev/null +++ b/env_developer @@ -0,0 +1 @@ +release/bash/env_developer \ No newline at end of file diff --git a/env_devloper b/env_devloper deleted file mode 120000 index bb04f15..0000000 --- a/env_devloper +++ /dev/null @@ -1 +0,0 @@ -release/bash/env_devloper \ No newline at end of file diff --git "a/tool_shared/document\360\237\226\211/make_rm_na.txt" "b/tool_shared/document\360\237\226\211/make_rm_na.txt" new file mode 100644 index 0000000..1bc6ff8 --- /dev/null +++ "b/tool_shared/document\360\237\226\211/make_rm_na.txt" @@ -0,0 +1,17 @@ + +1. install coreuitils +git clone https://github.com/coreutils/coreutils.git +cd coreutils + +2. add mods to remove. Note remove in the cc🖉 directory + +3. + +./bootstrap +./configure +make + +4. find rm as src/rm, move to amd64 as rm_na + + + -- 2.20.1