[PATCH app/xcursorgen] Update README for gitlab migration

[Alan Coopersmith]

Signed-off-by: Alan Coopersmith <***@oracle.com>
---
README | 12 ++----------
1 file changed, 2 insertions(+), 10 deletions(-)

diff --git a/README b/README
index 6e46f96..f830ada 100644
--- a/README
+++ b/README
@@ -1,25 +1,17 @@
xcursorgen prepares X11 cursor sets for use with libXcursor.

All questions regarding this software should be directed at the
Xorg mailing list:

http://lists.freedesktop.org/mailman/listinfo/xorg

-Please submit bug reports to the Xorg bugzilla:
-
- https://bugs.freedesktop.org/enter_bug.cgi?product=xorg
-
The master development code repository can be found at:

- git://anongit.freedesktop.org/git/xorg/app/xcursorgen
-
- http://cgit.freedesktop.org/xorg/app/xcursorgen
-
-For patch submission instructions, see:
+ https://gitlab.freedesktop.org/xorg/app/xcursorgen

- http://www.x.org/wiki/Development/Documentation/SubmittingPatches
+Please submit bug reports and requests to merge patches there.

For more information on the git code manager, see:

http://wiki.x.org/wiki/GitPage

[Alan Coopersmith]

Does anyone have feedback on changing our README's like this? While I
sent this out as a patch to a specific repo, I figured once we have
an agreed upon template, we'd apply it to all of the repos.

-alan-

Post by Alan Coopersmith
---
README | 12 ++----------
1 file changed, 2 insertions(+), 10 deletions(-)
diff --git a/README b/README
index 6e46f96..f830ada 100644
--- a/README
+++ b/README
@@ -1,25 +1,17 @@
xcursorgen prepares X11 cursor sets for use with libXcursor.
All questions regarding this software should be directed at the
http://lists.freedesktop.org/mailman/listinfo/xorg
-
- https://bugs.freedesktop.org/enter_bug.cgi?product=xorg
-
- git://anongit.freedesktop.org/git/xorg/app/xcursorgen
-
- http://cgit.freedesktop.org/xorg/app/xcursorgen
-
+ https://gitlab.freedesktop.org/xorg/app/xcursorgen
- http://www.x.org/wiki/Development/Documentation/SubmittingPatches
+Please submit bug reports and requests to merge patches there.
http://wiki.x.org/wiki/GitPage

[Peter Hutterer]

Post by Alan Coopersmith
Does anyone have feedback on changing our README's like this? While I
sent this out as a patch to a specific repo, I figured once we have
an agreed upon template, we'd apply it to all of the repos.

oh well, if you ask... :)

Post by Alan Coopersmith

Post by Alan Coopersmith
---
README | 12 ++----------
1 file changed, 2 insertions(+), 10 deletions(-)
diff --git a/README b/README
index 6e46f96..f830ada 100644
--- a/README
+++ b/README
@@ -1,25 +1,17 @@
xcursorgen prepares X11 cursor sets for use with libXcursor.
All questions regarding this software should be directed at the
http://lists.freedesktop.org/mailman/listinfo/xorg
-
- https://bugs.freedesktop.org/enter_bug.cgi?product=xorg
-
- git://anongit.freedesktop.org/git/xorg/app/xcursorgen
-
- http://cgit.freedesktop.org/xorg/app/xcursorgen
-
+ https://gitlab.freedesktop.org/xorg/app/xcursorgen
- http://www.x.org/wiki/Development/Documentation/SubmittingPatches

IMO we (i.e. not me but someone else) should update that URL for the
glorious gitlab-enabled present and leave it in the README

Post by Alan Coopersmith

Post by Alan Coopersmith
+Please submit bug reports and requests to merge patches there.
http://wiki.x.org/wiki/GitPage

this link needs to go and possibly merged into the SubmittingPatches page
(which could be renamed, because why not)

Cheers,
Peter
_______________________________________________
xorg-***@lists.x.org: X.Org development
Archives: http://lists.x.org/archives/xorg-devel
Info: https://lists.x.org/mailman/listi

[Alan Coopersmith]

Signed-off-by: Alan Coopersmith <***@oracle.com>
---
v2: Moved to README.md and reduced whitespace in front of URLs so that
gitlab renders them as links instead of code fragements - see
https://gitlab.freedesktop.org/alanc/xcursorgen for formatted view
Restored link to Submitting Patches page so that we have a place to
provide instructions on how we use gitlab.
Removed GitPage link.
Changed mailman link from fd.o to x.org URL

README | 25 -------------------------
README.md | 17 +++++++++++++++++
2 files changed, 17 insertions(+), 25 deletions(-)
delete mode 100644 README
create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 6e46f96..0000000
--- a/README
+++ /dev/null
@@ -1,25 +0,0 @@
-xcursorgen prepares X11 cursor sets for use with libXcursor.
-
-All questions regarding this software should be directed at the
-Xorg mailing list:
-
- http://lists.freedesktop.org/mailman/listinfo/xorg
-
-Please submit bug reports to the Xorg bugzilla:
-
- https://bugs.freedesktop.org/enter_bug.cgi?product=xorg
-
-The master development code repository can be found at:
-
- git://anongit.freedesktop.org/git/xorg/app/xcursorgen
-
- http://cgit.freedesktop.org/xorg/app/xcursorgen
-
-For patch submission instructions, see:
-
- http://www.x.org/wiki/Development/Documentation/SubmittingPatches
-
-For more information on the git code manager, see:
-
- http://wiki.x.org/wiki/GitPage
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8f33335
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+xcursorgen prepares X11 cursor sets for use with libXcursor.
+
+All questions regarding this software should be directed at the
+Xorg mailing list:
+
+ http://lists.x.org/mailman/listinfo/xorg
+
+The master development code repository can be found at:
+
+ https://gitlab.freedesktop.org/xorg/app/xcursorgen
+
+Please submit bug reports and requests to merge patches there.
+
+For patch submission instructions, see:
+
+ http://www.x.org/wiki/Development/Documentation/SubmittingPatches
+

[Alan Coopersmith]

Signed-off-by: Alan Coopersmith <***@oracle.com>
---

v2: Moved to README.md and reduced whitespace in front of URLs so that
gitlab renders them as links instead of code fragements - see
https://gitlab.freedesktop.org/alanc/xcursorgen for formatted view
Restored link to Submitting Patches page so that we have a place to
provide instructions on how we use gitlab.
Removed GitPage link.
Changed mailman link from fd.o to x.org URL
v3: Change remaining http URLs to https

README | 25 -------------------------
README.md | 17 +++++++++++++++++
2 files changed, 17 insertions(+), 25 deletions(-)
delete mode 100644 README
create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 6e46f96..0000000
--- a/README
+++ /dev/null
@@ -1,25 +0,0 @@
-xcursorgen prepares X11 cursor sets for use with libXcursor.
-
-All questions regarding this software should be directed at the
-Xorg mailing list:
-
- http://lists.freedesktop.org/mailman/listinfo/xorg
-
-Please submit bug reports to the Xorg bugzilla:
-
- https://bugs.freedesktop.org/enter_bug.cgi?product=xorg
-
-The master development code repository can be found at:
-
- git://anongit.freedesktop.org/git/xorg/app/xcursorgen
-
- http://cgit.freedesktop.org/xorg/app/xcursorgen
-
-For patch submission instructions, see:
-
- http://www.x.org/wiki/Development/Documentation/SubmittingPatches
-
-For more information on the git code manager, see:
-
- http://wiki.x.org/wiki/GitPage
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a935f4e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+xcursorgen prepares X11 cursor sets for use with libXcursor.
+
+All questions regarding this software should be directed at the
+Xorg mailing list:
+
+ https://lists.x.org/mailman/listinfo/xorg
+
+The master development code repository can be found at:
+
+ https://gitlab.freedesktop.org/xorg/app/xcursorgen
+
+Please submit bug reports and requests to merge patches there.
+
+For patch submission instructions, see:
+
+ https://www.x.org/wiki/Development/Documentation/SubmittingPatches
+

[Peter Hutterer]

Post by Alan Coopersmith
---
v2: Moved to README.md and reduced whitespace in front of URLs so that
gitlab renders them as links instead of code fragements - see
https://gitlab.freedesktop.org/alanc/xcursorgen for formatted view
Restored link to Submitting Patches page so that we have a place to
provide instructions on how we use gitlab.
Removed GitPage link.
Changed mailman link from fd.o to x.org URL
v3: Change remaining http URLs to https
README | 25 -------------------------
README.md | 17 +++++++++++++++++
2 files changed, 17 insertions(+), 25 deletions(-)
delete mode 100644 README
create mode 100644 README.md
diff --git a/README b/README
deleted file mode 100644
index 6e46f96..0000000
--- a/README
+++ /dev/null
@@ -1,25 +0,0 @@
-xcursorgen prepares X11 cursor sets for use with libXcursor.
-
-All questions regarding this software should be directed at the
-
- http://lists.freedesktop.org/mailman/listinfo/xorg
-
-
- https://bugs.freedesktop.org/enter_bug.cgi?product=xorg
-
-
- git://anongit.freedesktop.org/git/xorg/app/xcursorgen
-
- http://cgit.freedesktop.org/xorg/app/xcursorgen
-
-
- http://www.x.org/wiki/Development/Documentation/SubmittingPatches
-
-
- http://wiki.x.org/wiki/GitPage
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a935f4e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+xcursorgen prepares X11 cursor sets for use with libXcursor.
+
+All questions regarding this software should be directed at the
+
+ https://lists.x.org/mailman/listinfo/xorg
+
+
+ https://gitlab.freedesktop.org/xorg/app/xcursorgen
+
+Please submit bug reports and requests to merge patches there.
+
+
+ https://www.x.org/wiki/Development/Documentation/SubmittingPatches
+
--
2.15.2
_______________________________________________
Archives: http://lists.x.org/archives/xorg-devel
Info: https://lists.x.org/mailman/listinfo/xorg-devel

_______________________________________________
xorg-***@lists.x.org: X.Org development
Archives: http://lists.x.org/archives/xorg-devel
Info: h

[Alan Coopersmith]

LGTM. Thanks Alan!

Thanks to you, Peter, & Ray for reviews. I merged this, and thought
"Okay, time to cut a new release." And then I found the mistake.

automake automatically includes a file named "README" in the tarball.
It does not include a file named "README.md".

So, we seem to have two choices:

1) Ship with README.md:
Just add "EXTRA_DIST = README.md" to Makefile.am in every component.
.
2) Ship with README:
Follow our pattern with Changelog & INSTALL files and add a macro
to xorg-macros.m4 to define a makefile macro such as:
README_CMD = cp -f $(top_srcdir)/README.md $(top_srcdir)/README
and in Makefile.am in every component:

+README:
+ $(README_CMD)
+
-dist-hook: ChangeLog INSTALL
+dist-hook: ChangeLog INSTALL README


Anyone have a preference? Shipping README.md seems easier - will it cause
problems for any distros or packagers?

[Alan Coopersmith]

LGTM.  Thanks Alan!

Thanks to you, Peter, & Ray for reviews.   I merged this, and thought
"Okay, time to cut a new release."  And then I found the mistake.
automake automatically includes a file named "README" in the tarball.
It does not include a file named "README.md".
    Just add "EXTRA_DIST = README.md" to Makefile.am in every component.
.
   Follow our pattern with Changelog & INSTALL files and add a macro
    README_CMD = cp -f $(top_srcdir)/README.md $(top_srcdir)/README
+    $(README_CMD)
+
-dist-hook: ChangeLog INSTALL
+dist-hook: ChangeLog INSTALL README
Anyone have a preference?   Shipping README.md seems easier - will it cause
problems for any distros or packagers?

3rd choice - this seems to work for me, shipping a file named README in the
tarball without any Makefile modifications:

% ln -s README.md README
% git add README
% git commit -m 'ln -s README.md README'

Is checking symlinks into git going to break Windows or any other platforms?

[Keith Packard]

Post by Alan Coopersmith
3rd choice - this seems to work for me, shipping a file named README in the

Yikes! Scary git-fu!

Maybe we can see if cmark-gfm is available? That's the github fork that
parses more useful common mark syntax files, which should be starting to
show up in distros (it's in Debian at least).

$ cmark-gfm --to plaintext README.md > README

if we actually want to generate a plaintext README file? Until then,
just copy it?

[Matthieu Herrb]

Post by Keith Packard

Post by Alan Coopersmith
3rd choice - this seems to work for me, shipping a file named README in the

Yikes! Scary git-fu!
Maybe we can see if cmark-gfm is available? That's the github fork that
parses more useful common mark syntax files, which should be starting to
show up in distros (it's in Debian at least).
$ cmark-gfm --to plaintext README.md > README

I'd prefer avoiding depending on tools that aren't widely available
yet to make release. I can't find it on Ubuntu LTS. (There is the
original cmark in OpenBSD ports but I didn't find it on Ubuntu LTS
either).

Post by Keith Packard
if we actually want to generate a plaintext README file? Until then,
just copy it?

I prefer to just ship README.md alone. As Ray say people are used to
that now.

[Alan Coopersmith]

Post by Keith Packard

Post by Alan Coopersmith
3rd choice - this seems to work for me, shipping a file named README in the

Yikes! Scary git-fu!
Maybe we can see if cmark-gfm is available? That's the github fork that
parses more useful common mark syntax files, which should be starting to
show up in distros (it's in Debian at least).
$ cmark-gfm --to plaintext README.md > README
if we actually want to generate a plaintext README file? Until then,
just copy it?

Perhaps if any modules have complex markup in their README's in the future
they can do that. Right now, the README.md is perfectly readable as plain
text without any scripting:

% cat README.md
xcursorgen prepares X11 cursor sets for use with libXcursor.

All questions regarding this software should be directed at the
Xorg mailing list:

https://lists.x.org/mailman/listinfo/xorg

The master development code repository can be found at:

https://gitlab.freedesktop.org/xorg/app/xcursorgen

Please submit bug reports and requests to merge patches there.

For patch submission instructions, see:

https://www.x.org/wiki/Development/Documentation/SubmittingPatches

[Ray Strode]

hi,

Post by Alan Coopersmith
Anyone have a preference? Shipping README.md seems easier - will it cause
problems for any distros or packagers?

i think README.md is the right way to go. presumably any packaging
challenges have been ironed out by now considering how widespread
gitlab/github is now.

Ray

[Alan Coopersmith]

hi,
Anyone have a preference?   Shipping README.md seems easier - will it cause
problems for any distros or packagers?
i think README.md is the right way to go.  presumably any packaging challenges
have been ironed out by now considering how widespread gitlab/github is now.

Since Keith objected to git committing symlinks, I'll go ahead with
EXTRA_DIST += README.md
when checking these in and leave anything fancier for someone else to
tackle in the future.

[Keith Packard]

Post by Alan Coopersmith

hi,
Anyone have a preference?   Shipping README.md seems easier - will it cause
problems for any distros or packagers?
i think README.md is the right way to go.  presumably any packaging challenges
have been ironed out by now considering how widespread gitlab/github is now.

Since Keith objected to git committing symlinks, I'll go ahead with

Yeah, it just seems like a bad idea somehow...

Post by Alan Coopersmith
EXTRA_DIST += README.md
when checking these in and leave anything fancier for someone else to
tackle in the future.

Sounds like a fine plan to me. Thanks for taking care of this.

[Ray Strode]

hi,

Post by Alan Coopersmith
Does anyone have feedback on changing our README's like this?

it should probably be renamed README.md so it shows up in the gitlab view
better.

Ray