From: Thomas Walker Lynch Date: Sun, 8 Dec 2024 06:50:36 +0000 (+0000) Subject: doc revision X-Git-Url: https://git.reasoningtechnology.com/style/%7Bstyle.link%7D?a=commitdiff_plain;h=7b139501e8044df726be9844aa20bf72437ddc8b;p=RT-project-share doc revision --- diff --git "a/document\360\237\226\211/Pencil_Suffix.html" "b/document\360\237\226\211/Pencil_Suffix.html" new file mode 100644 index 0000000..f0cbe01 --- /dev/null +++ "b/document\360\237\226\211/Pencil_Suffix.html" @@ -0,0 +1,134 @@ + + + + + + + Pencil Suffix + + + +
+

The Pencil Suffix and Authored Files

+ +

How to Use the Pencil Suffix

+ +

The pencil suffix is a Unicode character, 🖉, that is placed as the last character of a filename or directory name. It signifies that the file, or contents of a so named directory, are uniquely authored and should not be deleted or rebuilt by clean scripts or build scripts. The pencil suffix also serves as a communication tool among team members as to where in the project edits should be inserted.

+ + Two methods for marking a file as authored: + + + +

The recommended method to mark files as authored is to place them in a directory, where the name of said directory ends with the pencil symbol. Directly marked files will then be exceptional cases.

+ +

Pencil suffix definition

+ +

By definition, the pencil suffix designates files or directories as leaves in the build tree. Hence, by definition pencil suffix files are not built by tools. It is a corollary that these files are the primary sources of material and serve as points of entry for edits by authors, whether human or AI. Thus we refer to these leaves as authored. At the time of writing, this definition is maintained by contract with the programers, along with the assistance of the rm_na tool.

+ +

Replace rm with rm_na in scripts

+ +

The rm_na command is a modified version of the standard rm command, and it refuses to delete files marked as being authored. This is true whether the file is marked as authored with a pencil suffix or is found in a directory tree marked as such.

+ +

Use rm_na in place of rm in scripts that clean, build, or otherwise manipulate project files.

+ +

While rm_na offers a safeguard, the pencil suffix itself does not enforce permissions. Users can still manually delete 🖉-marked files using rm, and roqque builds can overwrite them.

+ +

Pencil suffix and editablity

+ +

The pencil suffix does not inherently restrict or permit editing. A file without the pencil suffix that has write permissions can also be edited; however, such edits are at risk of being overwritten or lost during builds or cleans. While lack of a pencil suffix on a file, or inclusion in such a directory, does not prevent a file from being edited - it does mean that it might not be advisable to edit such a file. Conversely, it is intended that a file marked as authored can be edited without fear of the edits being overwritten. Hence pencil suffix files are the appropriate places to insert edits into a project. In this sense the pencil suffix does indicate a file is 'editable'; however, this is not the definition of the pencil suffix, rather it is a property that emerges from the definition.

+ +

Symbolic Links

+ +

Symbolic links, while facilitating access to authored files, are independent entities that merely point to targets. As such, the link itself is not an authored file, and its lifecycle is separate from the content it references. A symbolic link can be created or deleted without impacting the authored content it points to.

+ +

Because symbolic links are not authored entities, they do not carry pencil suffixes, even when their targets do. This distinction ensures that the pencil suffix remains specific to authored files and directories, highlighting their preservation within the project.

+ +

However, this lack of pencil suffix on links can create confusion. Users viewing symbolic links in a directory listing may overlook authored content if they rely solely on the link names. The intended edit points within the project might not be apparent unless users examine the targets of the links.

+ +

To mitigate potential confusion, file browsers or editors that visually distinguish symbolic links from regular files are highly valuable. These tools help users identify links at a glance, preserving the clarity of authored content within the project structure.

+ + + + +

Hard Links

+ +

Among multiple hard links, none is distinguished as being the primary file link. Hence, should a hard link point at an authored file, and that hardlink is not in a directory that already identifies it as an authored file, it should have the pencil suffix. It is the only option available, because in general we can not know the order of deletion of the hard links, and thus do not know which will be the last one that should not be deleted. Hard links are strange beasts that should be avoided for many other reasons as well.

+ + +

Future direction

+ +

In the future we hope for tighter integration with the OS, perhaps through use of sub-users (see the subu project), or through a property based file system. For now it is a communication tool, one which is strengthened through use of the rm_na command.

+ + + + 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 08c270b..0000000 --- "a/document\360\237\226\211/pencil_suffix.html" +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - Pencil Attribute in Directory Structure - - - -
-

The Pencil Suffix and Authored Files

- -

How to Use the Pencil Suffix

- -

The pencil suffix is a Unicode character, 🖉, that is placed as the last character of a filename or directory name. It signifies that the file, or contents of a so named directory, are uniquely authored and should not be deleted or rebuilt by clean scripts or build scripts. The pencil suffix also serves as a communication tool among team members.

- - Two methods for marking a file as authored: -
    -
  • Directory with Pencil Suffix: This method marks all contents within the directory sub-tree as being authored.
    • -
  • File Name Last Character as Pencil: This directly marks the file itself as authored and protected.
    • -
- - -

The recommended method to mark files as authored is to place them in a directory, where the name of said directory ends with the pencil symbol. Directly marked files will then be exceptional cases.

- -

Replace rm with rm_na in scripts

-

The rm_na command is a modified version of the standard rm command that refuses to delete files marked as being authored. - This is true whether the file is marked as authored with a pencil - suffix or is found in a directory tree marked as such. - - -

Use rm_na in place of rm in scripts that clean, build, or otherwise manipulate project files.

- -

While rm_na offers a safeguard, the pencil suffix itself does not enforce permissions. Users can still manually delete 🖉-marked files using rm, and roqque builds can overwrite them. Therefore, programmers should remain cautious.

- -

Pencil suffix and editablity

- -

The pencil suffix does not inherently restrict or permit editing. A file without the pencil suffix that has write permissions can also be edited; however, such edits are at risk of being overwritten or lost during builds or cleans. While lack of a pencil suffix on a file, or inclusion in such a directory, does not prevent a file from being edited - it does mean that it might not be advisable to edit such a file. Conversely, it is intended that a file marked as authored can be edited without fear of - the edits being overwritten. Hence these are the appropriate places to insert edits into a project. In this sense the pencil suffix does indicate a file is 'editable'.

- -

Symbolic Links

- -

A symbolic link can facilitate access to authored files; however, the link itself is independently created or deleted. Hence, a pencil suffix on a target file or directory does not reflect through to the name given to the link. The pencil suffix is about protecting authored content from deletion, but the link can be deleted without losing the authored content. Consequently, a symbolic link name will never have a pencil suffix.

- -

Symbolic links not carrying pencil suffixes suggests that a distinction be made between the pencil suffix indicating authored material that should not be deleted by project scripts, and that of the pencil indicating where edits should be inserted into the project. This is because dropping the pencil on the link name weakens the interpretation of the pencil suffix as indicting points in the project where edits should be made. The target files still indicate this, but a user might only see the symbolic links in the directory listing.

- -

Hard Links

- -

Among multiple hard links, none is distinguished as being the primary file link. Hence, should a hard link point at an authored file, and that hardlink is not in a directory that already identifies it as an authored file, it should have the pencil suffix. It is the only option available, because in general we can not know the order of deletion of the hard links, and thus do not know which will be the last one that should not be deleted. Hard links are strange beasts that should be avoided for many other reasons as well.

- - -

Future direction

- -

In the future we hope for tighter integration with the OS, perhaps through use of sub-users (see the subu project), or through a property based file system. For now it is a communication tool, one which is strengthened through use of the rm_na command.

- - - -