Proposal: Support for commit comments


(Amir Michail) #1

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.


(Douglas Gregor) #2

This has nothing to do with Swift.

  - Doug

···

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.


(Amir Michail) #3

Aren’t comments part of Swift?

···

On Dec 21, 2015, at 5:38 PM, Douglas Gregor <dgregor@apple.com> wrote:

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.

This has nothing to do with Swift.

  - Doug


(Douglas Gregor) #4

*Commit messages* aren’t part of Swift.

  - Doug

···

On Dec 21, 2015, at 2:53 PM, Amir Michail <amichail@gmail.com> wrote:

On Dec 21, 2015, at 5:38 PM, Douglas Gregor <dgregor@apple.com> wrote:

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.

This has nothing to do with Swift.

  - Doug

Aren’t comments part of Swift?


(Greg Parker) #5

Comments are, but commits are not. We don't have any way to force source control systems like git or svn to scan our files for special comments.

···

On Dec 21, 2015, at 2:53 PM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 5:38 PM, Douglas Gregor <dgregor@apple.com> wrote:

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.

This has nothing to do with Swift.

Aren’t comments part of Swift?

--
Greg Parker gparker@apple.com Runtime Wrangler


(Amir Michail) #6

Upon a commit, these comments would be automatically removed from the source and combined into a single commit comment.

In this way, you would not need to remember what changes you are committing in order to make up a commit comment. You just comment the code as you make the changes.

A special syntax would be used for commit comments so they are never confused with normal comments.

Note also that in the case of multiple changes being committed at once, these commit comments would give a more accurate mapping of the individual comments to the code changes they refer to.

This has nothing to do with Swift.

Aren’t comments part of Swift?

Comments are, but commits are not. We don't have any way to force source control systems like git or svn to scan our files for special comments.

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

···

On Dec 21, 2015, at 5:56 PM, Greg Parker <gparker@apple.com> wrote:

On Dec 21, 2015, at 2:53 PM, Amir Michail via swift-evolution <swift-evolution@swift.org <mailto:swift-evolution@swift.org>> wrote:

On Dec 21, 2015, at 5:38 PM, Douglas Gregor <dgregor@apple.com> wrote:

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

--
Greg Parker gparker@apple.com <mailto:gparker@apple.com> Runtime Wrangler


(Brent Royal-Gordon) #7

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

Xcode is not part of the Swift.org project either.

···

--
Brent Royal-Gordon
Architechies


(karl catigbe) #8

Pre commit hook. What you want is a pre commit hook.

···

On Monday, December 21, 2015, Amir Michail via swift-evolution < swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 5:56 PM, Greg Parker <gparker@apple.com > <javascript:_e(%7B%7D,'cvml','gparker@apple.com');>> wrote:

On Dec 21, 2015, at 2:53 PM, Amir Michail via swift-evolution < > swift-evolution@swift.org > <javascript:_e(%7B%7D,'cvml','swift-evolution@swift.org');>> wrote:

On Dec 21, 2015, at 5:38 PM, Douglas Gregor <dgregor@apple.com > <javascript:_e(%7B%7D,'cvml','dgregor@apple.com');>> wrote:

On Dec 21, 2015, at 11:07 AM, Amir Michail via swift-evolution < > swift-evolution@swift.org > <javascript:_e(%7B%7D,'cvml','swift-evolution@swift.org');>> wrote:

Upon a commit, these comments would be automatically removed from the
source and combined into a single commit comment.

In this way, you would not need to remember what changes you are
committing in order to make up a commit comment. You just comment the code
as you make the changes.

A special syntax would be used for commit comments so they are never
confused with normal comments.

Note also that in the case of multiple changes being committed at once,
these commit comments would give a more accurate mapping of the individual
comments to the code changes they refer to.

This has nothing to do with Swift.

Aren’t comments part of Swift?

Comments are, but commits are not. We don't have any way to force source
control systems like git or svn to scan our files for special comments.

If it is part of the language standard and is supported by Xcode, then
many source control systems/IDEs will support it also as it gives them a
competitive advantage.

--
Greg Parker gparker@apple.com
<javascript:_e(%7B%7D,'cvml','gparker@apple.com');> Runtime Wrangler

--
"Those who would give up liberty for the sake of security deserve neither
liberty nor security."
-Benjamin Franklin


(Amir Michail) #9

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

Xcode is not part of the Swift.org project either.

It doesn’t have to be. But if Xcode supports it, then more people will know about this language feature.

···

On Dec 21, 2015, at 6:03 PM, Brent Royal-Gordon <brent@architechies.com> wrote:

--
Brent Royal-Gordon
Architechies


(David Owens II) #10

What you are talking about are source control hooks. They don’t belong in a language as a language is completely agnostic of a source control system, assuming on is even used.

···

On Dec 21, 2015, at 3:04 PM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 6:03 PM, Brent Royal-Gordon <brent@architechies.com> wrote:

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

Xcode is not part of the Swift.org project either.

It doesn’t have to be. But if Xcode supports it, then more people will know about this language feature.

--
Brent Royal-Gordon
Architechies

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution


(Amir Michail) #11

What you are talking about are source control hooks. They don’t belong in a language as a language is completely agnostic of a source control system, assuming on is even used.

I thought Apple was all about integration to create seamless experiences?

···

On Dec 21, 2015, at 6:18 PM, David Owens II <david@owensd.io> wrote:

On Dec 21, 2015, at 3:04 PM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 6:03 PM, Brent Royal-Gordon <brent@architechies.com> wrote:

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

Xcode is not part of the Swift.org project either.

It doesn’t have to be. But if Xcode supports it, then more people will know about this language feature.

--
Brent Royal-Gordon
Architechies

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution


(Craig Cruden) #12

Amir,

You might want to read the scope of swift-evolution:

https://github.com/possen/swift-evolution/blob/master/process.md

···

On 2015-12-22, at 6:20:08, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 6:18 PM, David Owens II <david@owensd.io> wrote:

What you are talking about are source control hooks. They don’t belong in a language as a language is completely agnostic of a source control system, assuming on is even used.

I thought Apple was all about integration to create seamless experiences?

On Dec 21, 2015, at 3:04 PM, Amir Michail via swift-evolution <swift-evolution@swift.org> wrote:

On Dec 21, 2015, at 6:03 PM, Brent Royal-Gordon <brent@architechies.com> wrote:

If it is part of the language standard and is supported by Xcode, then many source control systems/IDEs will support it also as it gives them a competitive advantage.

Xcode is not part of the Swift.org project either.

It doesn’t have to be. But if Xcode supports it, then more people will know about this language feature.

--
Brent Royal-Gordon
Architechies

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution

_______________________________________________
swift-evolution mailing list
swift-evolution@swift.org
https://lists.swift.org/mailman/listinfo/swift-evolution