Wrong way arrows in GIT documentation

  • Thread starter Thread starter the_emi_guy
  • Start date Start date
AI Thread Summary
The discussion centers on the representation of arrows in Git workflow documentation, which are often drawn pointing backward from child commits to parent commits. This design choice reflects the way Git tracks commit history, emphasizing the dependencies of a version on its predecessors rather than the evolution of the software itself. Git creates standalone snapshots of the code at each version, unlike other systems that may record only differences and thus have dependencies on prior versions. The backward arrows serve practical purposes: they help programmers trace the origin of code, which is essential for debugging and understanding the codebase. Additionally, when a new version is created, it maintains a stable pointer to its parent commits, ensuring consistency across different versions and facilitating easier comparison and merging of repositories. This design choice aligns with the needs of developers who frequently analyze past versions rather than future changes. Overall, the backward arrows in Git documentation are a reflection of its underlying architecture and the typical workflow of programmers.
the_emi_guy
Messages
766
Reaction score
79
Anyone have any idea why the arrows in GIT workflow documentation are always drawn backwards?

For example, the logical way to diagram C4 and C5 merging to become C6 would be with arrows from C4 and C5 into C6, not the other way around.
 

Attachments

  • git.jpg
    git.jpg
    4.5 KB · Views: 558
Technology news on Phys.org
The arrows are not showing the direction of evolution of the software. They are showing the dependencies of a version on prior versions.
 
  • Like
Likes the_emi_guy
From chapter 3 of the Pro Git book

When you make a commit, Git stores a commit object that contains a pointer to the snapshot of the content you staged. This object also contains the author’s name and email, the message that you typed, and pointers to the commit or commits that directly came before this commit (its parent or parents): zero parents for the initial commit, one parent for a normal commit, and multiple parents for a commit that results from a merge of two or more branches.

So in the tool you use, I would think the diagram show parent arrows because that is the direct information present for a version. You can of course flip the arrows in your head (or by using another tool perhaps) if you like, as long as you remember that behind the scene children points to parents and not the other way around.
 
  • Like
Likes the_emi_guy and FactChecker
FactChecker said:
The arrows are not showing the direction of evolution of the software. They are showing the dependencies of a version on prior versions.

But in GIT there are no dependencies on prior versions, GIT creates fully standalone snapshots of the code at each version (unlike ClearCase where only differences are recorded, so there are dependencies on prior versions).

In GIT, C4 and C5 are merged to form a standalone snapshot of the merged C6 that no longer depends on C4 or C5 for reconstitution.

In other areas of science and engineering arrows generally denote evolution when things are changed/combined to form new things (CH4 + 2O2 → CO2 + 2H2O).

So as a non-computer scientist who has had a need to learn GIT, I was just wondering if there is a good reason for showing the reverse.
 
the_emi_guy said:
But in GIT there are no dependencies on prior versions, GIT creates fully standalone snapshots of the code at each version (unlike ClearCase where only differences are recorded, so there are dependencies on prior versions).
Sort of, but not really. It doesn't create a new snapshot of the entire repository, only the files that have changed. It works by creating hashes of the files, so if two files are the same between two different branches, they will point to the same file.
 
  • Like
Likes the_emi_guy and FactChecker
the_emi_guy said:
But in GIT there are no dependencies on prior versions,
So as a non-computer scientist who has had a need to learn GIT, I was just wondering if there is a good reason for showing the reverse.
As @Filip Larsen said, you can always flip the arrows in your mind, but there is are a couple of reasons for pointing backward. The first I am sure of and the second I am assuming:
1) As a programmer trying to document, debug, or understand a program, you need to know where the code you are looking at came from and why it is there. So you are tracing backward, all day, every day. As a working programmer, it is not nearly as often that you are looking at code and tracing forward to see what happened in later versions. (There might be hundreds of later versions.)
2) When you make a new version, you also make a new record that points back to the parents. That pointer record doesn't need to change later. So if two people download the same version for development, all the history would remain identical as their two versions diverged. If it pointed forward, the pointer record for a parent version would change every time a new version was derived from it. The data base would be less stable and it would be more difficult to compare and merge GIT depositories.
 
Last edited:
  • Like
Likes the_emi_guy
newjerseyrunner said:
Sort of, but not really. It doesn't create a new snapshot of the entire repository, only the files that have changed. It works by creating hashes of the files, so if two files are the same between two different branches, they will point to the same file.
FactChecker said:
As @Filip Larsen said, you can always flip the arrows in your mind, but there is are a couple of reasons for pointing backward. The first I am sure of and the second I am assuming:
1) As a programmer trying to document, debug, or understand a program, you need to know where the code you are looking at came from and why it is there. So you are tracing backward, all day, every day. As a working programmer, it is not nearly as often that you are looking at code and tracing forward to see what happened in later versions. (There might be hundreds of later versions.)
2) When you make a new version, you also make a new record that points back to the parents. That pointer record doesn't need to change later. So if two people download the same version for development, all the history would remain identical as their two versions diverged. If it pointed forward, the pointer record for a parent version would change every time a new version was derived from it. The data base would be less stable and it would be more difficult to compare and merge GIT depositories.

Very good, thanks, I get it.

Thanks everyone.
 

Similar threads

Replies
3
Views
2K
Replies
2
Views
7K
Replies
10
Views
2K
Replies
3
Views
2K
Replies
59
Views
5K
Replies
14
Views
5K
Replies
14
Views
2K
Back
Top