Wrong way arrows in GIT documentation

  • Thread starter the_emi_guy
  • Start date
In summary, the arrows in GIT workflow documentation are drawn backwards because they represent the dependencies of a version on prior versions, not the direction of the software's evolution. This is due to the way Git creates standalone snapshots of the code at each version, using hashes to point to the same file if it hasn't changed. Additionally, tracing backward is more common for programmers when debugging or understanding code, and pointing backward allows for a more stable database and easier comparison and merging of Git repositories.
  • #1
the_emi_guy
766
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: 497
Technology news on Phys.org
  • #2
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
  • #3
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
  • #4
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.
 
  • #5
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
  • #6
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
  • #7
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.
 

Related to Wrong way arrows in GIT documentation

1. What are wrong way arrows in GIT documentation?

Wrong way arrows in GIT documentation refer to the direction of the arrows used in diagrams to represent the flow of commits and changes in a GIT repository. The arrows point from newer commits to older commits, so if an arrow is pointing in the opposite direction, it is considered a "wrong way" arrow.

2. Why are wrong way arrows important to understand in GIT documentation?

Wrong way arrows are important because they help users understand the chronological order of commits and changes in a GIT repository. This can be helpful when trying to troubleshoot or understand the history of a project.

3. How can I fix wrong way arrows in my GIT repository?

Wrong way arrows cannot be "fixed" as they are simply a representation of the chronological order of commits. However, if you notice that the arrows in your repository are consistently pointing in the wrong direction, it may be a sign of a larger issue with your workflow or repository structure.

4. Are wrong way arrows always a problem in GIT documentation?

No, wrong way arrows are not always a problem in GIT documentation. In some cases, they may be intentional, such as when merging branches or reverting changes. However, if you consistently see wrong way arrows in your repository, it may be worth investigating further to ensure proper version control practices are being followed.

5. Can I change the direction of the arrows in GIT documentation?

No, the direction of arrows in GIT documentation cannot be changed. They are a standard representation used to depict the chronological order of commits and changes in a GIT repository.

Similar threads

  • Electrical Engineering
Replies
3
Views
1K
  • Electrical Engineering
Replies
10
Views
1K
  • Programming and Computer Science
Replies
4
Views
457
  • Engineering and Comp Sci Homework Help
Replies
3
Views
1K
  • Other Physics Topics
Replies
14
Views
3K
Replies
9
Views
2K
  • Quantum Physics
2
Replies
59
Views
4K
  • Engineering and Comp Sci Homework Help
Replies
2
Views
7K
  • Programming and Computer Science
Replies
14
Views
1K
  • Sci-Fi Writing and World Building
Replies
4
Views
2K
Back
Top