issue-#100 Controls documentation

[DGDanforth]

You can use Tortoise Git->Show Log with a mouse-right click on your clone directory.
Then you see what has been committed.

If the topmost change was "Controls documentation fixed by Douglas Danforth" this was the start of the fix committed by Ivan.

If it is not there, you can clone a new repo or you can pull the changes from the origin to your clone by means of
Tortoise-Git->Pull...

- Josef

OK, I see "Revision: 200f9f4ff0d98ca62ac173858a207b2db74b3ae8
Author: Douglas G Danforth <DGDanforth@users.noreply.github.com>
Date: 7/4/2016 6:55:09 PM
Message:
Merge pull request #116 from BlackBoxCenter/issue-#100"
So it appears I am in sync with the latest version for issue #100.
That's awfully obscure. I would think that information would be brought forward and made more obvious.
I still feel extremely uncertain about using Git.
-Doug

[Josef Templ]

Doug, you are not in sync.
Please read the commit message in detail and see the list of changed files.

The relevant last entry is:

SHA-1: 3f112671c56f7f1452e671ba61763c761361ce45

* Controls documentation fixed by Douglas Danforth. Refs: #100


In this example, by the way, you see a malformed commit message.
It should end with a ".". Ivan sometimes forgets to put this dot at the end.

For all:
Why is it important to have a dot at the end?
It is important to have something at the end in order to be able to do string searches for issue numbers.
By searching e.g. for #10 you don't want to find results related to #100, so you need an end marker.
To be able to do such searches it is important to have some marker at the beginning AND at the end of the issue number.
Since this is the end of the title message it was natural to use the dot by convention.
Please stick to this convention.

- Josef

[Ivan Denisov]

OK, I see "Revision: 200f9f4ff0d98ca62ac173858a207b2db74b3ae8

After cloning the repository you should switch to the issue branch #100.

[Ivan Denisov]

Ivan sometimes forgets to put this dot at the end.

I am not putting it intentionally
I do not see the reason for such a rule, however if it is important for you, I will put such dot.

[Josef Templ]

Again, the reason is that sometimes one wants to do a text search for issue numbers in git.
I tried to explain this several times in the past but without much success.
It is also described in the wiki, see http://wiki.blackboxframework.org/index ... p_with_Git.

- Josef

[DGDanforth]

Doug, you are not in sync.
Please read the commit message in detail and see the list of changed files.

The relevant last entry is:

SHA-1: 3f112671c56f7f1452e671ba61763c761361ce45

* Controls documentation fixed by Douglas Danforth. Refs: #100

- Josef

and how in heavens name am I supposed to be able to interpret that string of characters!?

[DGDanforth]

OK, I see "Revision: 200f9f4ff0d98ca62ac173858a207b2db74b3ae8

After cloning the repository you should switch to the issue branch #100.

How do I switch to the issue branch #100?

[Josef Templ]

Doug, by now you know that Tortoise Git works with a context menu.
Use the context menu to see on which branch you are.

Tortoise Git->Switch/Checkout...

It shows on which branch you are when it is opened.
If you are not on issue-#100, throw your clone away and clone a new one. This is the easy way.
Also, if you are on issue-#100 but don't have the latest commit from Ivan (see below) throw your clone
away and get a new one.
Use Tortoise's context menu item Git Clone... to create a clone.
Check 'Branch' in the clone dialog and specify issue-#100!
Then your clone will be switched to issue-#100 automatically and you will work
on issue-#100 and push back to issue-#100 on the origin repository.
On that clone you will see in the log the commit by Ivan.


A git commit always has a hash code. This identifies the commit globally and uniquely.
It is idebtified by means of an SHA value. SHA is a hash algorithm. It can compress
any byte sequence into a unique hash code (well, almost unique, but in git it is considered unique).
You don't need to read the SHA value.
You should read the commit message text.

"Controls documentation fixed by Douglas Danforth. Refs: #100"

This is what Ivan committed due to your observation that the docu of Controls needs a fix.

- Josef

[DGDanforth]

Tortoise Git->Switch/Checkout...

Its late so I probably should not be replying but what the heck...
I don't know what "Tortoise Git->Switch/Checkout..." refers to.
There is no "Switch" option when I start it up. I only see "Branch".
When I select that I see

where I have selected "Tracking Branch".
Are we out of step?

[DGDanforth]

I should have posted this first.
Here is what I see when I start Git