Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add RCS resources #6669

Closed
wants to merge 1 commit into from
Closed

Add RCS resources #6669

wants to merge 1 commit into from

Conversation

cwfoo
Copy link
Contributor

@cwfoo cwfoo commented Jan 13, 2022

What does this PR do?

Add Revision Control System (RCS) resources.

For resources

Description

Add two resources:

  • RCS — A System for Version Control — The paper where the original author of RCS describes RCS.
  • RCS Handbook — A book that shows how to use RCS.

Why is this valuable (or not)?

RCS Handbook is particularly valuable because it goes far beyond the man pages and the short tutorials found on various websites. For example, the book teaches about branching, merging, and managing software projects.

How do we know it's really free?

These texts are made available on the Purdue RCS Homepage.

For book lists, is it a book? For course lists, is it a course? etc.

One paper and one book.

Checklist:

  • Read our contributing guidelines
  • Search for duplicates.
  • Include author(s) and platform where appropriate.
  • Put lists in alphabetical order, correct spacing.
  • Add needed indications (PDF, access notes, under construction)

@davorpa davorpa requested a review from a team January 13, 2022 05:27
### RCS

* [RCS — A System for Version Control](https://www.cs.purdue.edu/homes/trinkle/RCShome/rcs.ps) - Walter F. Tichy (PS)
* [RCS Handbook](https://www.cs.purdue.edu/homes/trinkle/RCShome/contrib/odonavan/RCS_Book.tar.Z) - Brian O’Donovan
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we accept compressed files?

Copy link
Member

@LuigiImVector LuigiImVector Jan 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some link that redirect to a compressed files so I think we accept those.

Example:

* [AutoHotkey Official Documentation](https://autohotkey.com/docs/AutoHotkey.htm) ([CHM](https://autohotkey.com/download/1.1/AutoHotkeyHelp.zip))

Although a .pdf or something easier to view would be better than a tar.z archive containing .ps files.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should probably remove that zip.

we can't provide enough context on our list to link to tar files.

If the purdue people thought the book was important to share, they'd produce a pdf or something of it. If they don't think it's worthwhile, why should we link to it?

@@ -2074,6 +2075,12 @@ That section got so big, we decided to split it into its own file, the [BY SUBJE
* [The Official Raspberry Pi Project Book 1 (2015)](https://magpi.raspberrypi.com/books/projects-1) (PDF)


### RCS

* [RCS — A System for Version Control](https://www.cs.purdue.edu/homes/trinkle/RCShome/rcs.ps) - Walter F. Tichy (PS)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixing file format notes

Suggested change
* [RCS — A System for Version Control](https://www.cs.purdue.edu/homes/trinkle/RCShome/rcs.ps) - Walter F. Tichy (PS)
* [RCS — A System for Version Control](https://www.cs.purdue.edu/homes/trinkle/RCShome/rcs.ps) - Walter F. Tichy (PostScript)

Are there any other format easier readable like PDF, ePub...?

Copy link
Contributor Author

@cwfoo cwfoo Jan 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that it would be better to replace the .ps link with the GNU link

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't list articles. There are millions of those. If we did, we would link to the gnu pdf.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davorpa GNU has a PDF version: gnu.org/software/rcs/tichy-paper.pdf FreeBSD too: docs.freebsd.org/44doc/psd/13.rcs/paper.pdf

I agree with Luigi and Eric attending to contrib guidelines, using PDF or ePUB, and even use a gnu.org as target domain. Meanwhile... I'd opt to fix file format notes with the proposed name

@davorpa davorpa added the question Needs clarification by involved users / reviewers label Jan 13, 2022
@davorpa
Copy link
Member

davorpa commented Jan 13, 2022

If is a version control system, we should remember include it later in the reorganization proposed via #5526

Copy link
Collaborator

@eshellman eshellman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not our goal to document 40 year old software "primarily of historical interest". Wikipedia has a good article on it. RCS is not worth a section of its own as far as I can tell. If there were a book on it we would include it in our CVS section, if we even had a CVS section. or our "history of software" section if we had that.

Also RCS is today too obscure an acronym for us to use as a heading.

Thank you for the suggestion; it is appreciated even if not accepted!

@@ -2074,6 +2075,12 @@ That section got so big, we decided to split it into its own file, the [BY SUBJE
* [The Official Raspberry Pi Project Book 1 (2015)](https://magpi.raspberrypi.com/books/projects-1) (PDF)


### RCS

* [RCS — A System for Version Control](https://www.cs.purdue.edu/homes/trinkle/RCShome/rcs.ps) - Walter F. Tichy (PS)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't list articles. There are millions of those. If we did, we would link to the gnu pdf.

### RCS

* [RCS — A System for Version Control](https://www.cs.purdue.edu/homes/trinkle/RCShome/rcs.ps) - Walter F. Tichy (PS)
* [RCS Handbook](https://www.cs.purdue.edu/homes/trinkle/RCShome/contrib/odonavan/RCS_Book.tar.Z) - Brian O’Donovan
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should probably remove that zip.

we can't provide enough context on our list to link to tar files.

If the purdue people thought the book was important to share, they'd produce a pdf or something of it. If they don't think it's worthwhile, why should we link to it?

@eshellman
Copy link
Collaborator

What do you think, @cwfoo ? (You were tied for sixth for most F-P-B contributions in 2021!)

@cwfoo
Copy link
Contributor Author

cwfoo commented Jan 17, 2022

@eshellman

It's not our goal to document 40 year old software "primarily of historical interest". Wikipedia has a good article on it. RCS is not worth a section of its own as far as I can tell. If there were a book on it we would include it in our CVS section, if we even had a CVS section. or our "history of software" section if we had that.

I occasionally use RCS myself, but I completely understand that RCS is widely considered obsolete these days (it was long ago removed from the base system of the BSDs). In any case, the "books" submitted in this pull request can easily be found through the most obvious webpages:

Thank you for the suggestion; it is appreciated even if not accepted!

This pull request can now be closed. This pull request can be revisited in the future when there are more appropriate sections in the book lists.


(You were tied for sixth for most F-P-B contributions in 2021!)

This is most surprising. 😆 Only 7 commits!

@eshellman eshellman closed this Jan 18, 2022
@davorpa davorpa added the 🗣️ locale:en Resources addressing "English" language label Feb 23, 2022
@cwfoo cwfoo deleted the rcs branch May 24, 2022 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Needs clarification by involved users / reviewers 🗣️ locale:en Resources addressing "English" language
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants