patches and low-level development discussion
 help / color / Atom feed
* [PATCH] Add and clarify matrix workarounds.
@ 2020-08-11 16:32 Philipp
  2020-08-11 18:31 ` Alyssa Ross
  0 siblings, 1 reply; 6+ messages in thread
From: Philipp @ 2020-08-11 16:32 UTC (permalink / raw)
  To: devel

I'm a matrix user and fiddled around with the room there a bit. My
findings were that the room itself seems to be fine, but the pretty
alias is broken in some way that I don't understand. I came up with two
ways to join the room via the internal ID and I also took the liberty to
modify the old workaround a little and made it more precise.
---
 participating.html | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/participating.html b/participating.html
index 811fcf4..58f2ff3 100644
--- a/participating.html
+++ b/participating.html
@@ -78,13 +78,15 @@ the web.
 <h3>Note for Matrix users</h3>
 
 <p>
-There appears to be an issue with Matrix's IRC bridge that prevents
-Matrix users from joining #spectrum.  The workaround is as follows:
+There appears to be an issue with Matrix's IRC bridged room that prevents
+Matrix users from joining the channel with the normal alias <q>#freenode_#spectrum:matrix.org</q>.  There are the following workarounds:
+
+<ul>
+  <li>Join the room via it's internal name: <q>/join !ZsIiqZmCTSWHpTQWaw:matrix.org</q>.
+  <li>Join the room via <a href="https://matrix.to/#/!ZsIiqZmCTSWHpTQWaw:matrix.org">matrix.to link</a>.</li>
+  <li>Ask the bridges appservice to invite you to the room: <q>/msg @appservice-irc:matrix.org !join #spectrum</q> and accept the invite.</li>
+</ul>
 
-<ol>
-  <li>Post <q>!join #spectrum</q> in your "Freenode IRC Bridge" chat.</li>
-  <li>Accept the invitation you are sent.</li>
-</ol>
 
 <p>
 If you experience this issue, kindly report it to the people who run
-- 
2.28.0

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] Add and clarify matrix workarounds.
  2020-08-11 16:32 [PATCH] Add and clarify matrix workarounds Philipp
@ 2020-08-11 18:31 ` Alyssa Ross
  2020-08-11 21:54   ` Philipp Steinpaß
  0 siblings, 1 reply; 6+ messages in thread
From: Alyssa Ross @ 2020-08-11 18:31 UTC (permalink / raw)
  To: Philipp; +Cc: devel

Philipp <philipp+spectrum@xndr.de> writes:

> I'm a matrix user and fiddled around with the room there a bit. My
> findings were that the room itself seems to be fine, but the pretty
> alias is broken in some way that I don't understand. I came up with two
> ways to join the room via the internal ID and I also took the liberty to
> modify the old workaround a little and made it more precise.
> ---
>  participating.html | 14 ++++++++------
>  1 file changed, 8 insertions(+), 6 deletions(-)

Thanks for the patch!  This should be very helpful.  I have a couple of
comments, but I'm happy to just fix them up myself if you prefer.

> diff --git a/participating.html b/participating.html
> index 811fcf4..58f2ff3 100644
> --- a/participating.html
> +++ b/participating.html
> @@ -78,13 +78,15 @@ the web.
>  <h3>Note for Matrix users</h3>
>  
>  <p>
> -There appears to be an issue with Matrix's IRC bridge that prevents
> -Matrix users from joining #spectrum.  The workaround is as follows:
> +There appears to be an issue with Matrix's IRC bridged room that prevents
> +Matrix users from joining the channel with the normal alias <q>#freenode_#spectrum:matrix.org</q>.  There are the following workarounds:

Text should be wrapped as it is everywhere else (I wrap at 70 because
it's the default in Emacs but it doesn't have to be exact).

The room name also isn't really a quotation, so probably doesn't really
make sense to be a <q>.  (I think I'd just not mark it up at all.)

> +
> +<ul>
> +  <li>Join the room via it's internal name: <q>/join !ZsIiqZmCTSWHpTQWaw:matrix.org</q>.
> +  <li>Join the room via <a href="https://matrix.to/#/!ZsIiqZmCTSWHpTQWaw:matrix.org">matrix.to link</a>.</li>
> +  <li>Ask the bridges appservice to invite you to the room: <q>/msg @appservice-irc:matrix.org !join #spectrum</q> and accept the invite.</li>

The messages probably make more sense as <kbd> than <q>.
The </li> can also be omitted.

> +</ul>
>  
> -<ol>
> -  <li>Post <q>!join #spectrum</q> in your "Freenode IRC Bridge" chat.</li>
> -  <li>Accept the invitation you are sent.</li>
> -</ol>
>  
>  <p>
>  If you experience this issue, kindly report it to the people who run
> -- 
> 2.28.0

As I said above, I'm happy to just fix up the patch myself and apply it if
you'd prefer.

One more thing -- this probably makes you a (minor) copyright holder in
this file.  Are you happy if I add "SPDX-FileCopyrightText: 2020
Philipp" to the copyright header at the top of the file?  (You can give
me a surname if you want, or not -- up to you.)  And would you prefer
your email address be included in the notice, or not (either is fine)?

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] Add and clarify matrix workarounds.
  2020-08-11 18:31 ` Alyssa Ross
@ 2020-08-11 21:54   ` Philipp Steinpaß
  2020-08-12 13:34     ` Alyssa Ross
  0 siblings, 1 reply; 6+ messages in thread
From: Philipp Steinpaß @ 2020-08-11 21:54 UTC (permalink / raw)
  To: Alyssa Ross; +Cc: Philipp, devel

Thank you for the remarks, they were all very helpfull.
If you want to include me in the copyright, you are free to use my full
name. It's in the mail header now.

P.S. Please feel free to comment on any potential problems with the
formatting of these patch mails, if you want to. It's my first time
using git via mail and I'd like todo it the proper way right away.

---
 participating.html | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/participating.html b/participating.html
index 811fcf4..10665ca 100644
--- a/participating.html
+++ b/participating.html
@@ -78,13 +78,18 @@ the web.
 <h3>Note for Matrix users</h3>
 
 <p>
-There appears to be an issue with Matrix's IRC bridge that prevents
-Matrix users from joining #spectrum.  The workaround is as follows:
-
-<ol>
-  <li>Post <q>!join #spectrum</q> in your "Freenode IRC Bridge" chat.</li>
-  <li>Accept the invitation you are sent.</li>
-</ol>
+There appears to be an issue with Matrix's IRC bridged room that prevents
+Matrix users from joining the channel with the normal alias
+#freenode_#spectrum:matrix.org. There are the following workarounds:
+
+<ul>
+  <li>Join the room via it's internal name:
+    <kbd>/join !ZsIiqZmCTSWHpTQWaw:matrix.org</kbd>.
+  <li>Join the room via
+    <a href="https://matrix.to/#/!ZsIiqZmCTSWHpTQWaw:matrix.org">matrix.to link</a>.</li>
+  <li>Ask the bridges appservice to invite you to the room:
+    <kbd>/msg @appservice-irc:matrix.org !join #spectrum</kbd> and accept the invite.
+</ul>
 
 <p>
 If you experience this issue, kindly report it to the people who run
-- 
2.28.0



Alyssa Ross writes:

> Philipp <philipp+spectrum@xndr.de> writes:
>
>> I'm a matrix user and fiddled around with the room there a bit. My
>> findings were that the room itself seems to be fine, but the pretty
>> alias is broken in some way that I don't understand. I came up with two
>> ways to join the room via the internal ID and I also took the liberty to
>> modify the old workaround a little and made it more precise.
>> ---
>>  participating.html | 14 ++++++++------
>>  1 file changed, 8 insertions(+), 6 deletions(-)
>
> Thanks for the patch!  This should be very helpful.  I have a couple of
> comments, but I'm happy to just fix them up myself if you prefer.
>
>> diff --git a/participating.html b/participating.html
>> index 811fcf4..58f2ff3 100644
>> --- a/participating.html
>> +++ b/participating.html
>> @@ -78,13 +78,15 @@ the web.
>>  <h3>Note for Matrix users</h3>
>>  
>>  <p>
>> -There appears to be an issue with Matrix's IRC bridge that prevents
>> -Matrix users from joining #spectrum.  The workaround is as follows:
>> +There appears to be an issue with Matrix's IRC bridged room that prevents
>> +Matrix users from joining the channel with the normal alias <q>#freenode_#spectrum:matrix.org</q>.  There are the following workarounds:
>
> Text should be wrapped as it is everywhere else (I wrap at 70 because
> it's the default in Emacs but it doesn't have to be exact).
>
> The room name also isn't really a quotation, so probably doesn't really
> make sense to be a <q>.  (I think I'd just not mark it up at all.)
>
>> +
>> +<ul>
>> +  <li>Join the room via it's internal name: <q>/join !ZsIiqZmCTSWHpTQWaw:matrix.org</q>.
>> +  <li>Join the room via <a href="https://matrix.to/#/!ZsIiqZmCTSWHpTQWaw:matrix.org">matrix.to link</a>.</li>
>> +  <li>Ask the bridges appservice to invite you to the room: <q>/msg @appservice-irc:matrix.org !join #spectrum</q> and accept the invite.</li>
>
> The messages probably make more sense as <kbd> than <q>.
> The </li> can also be omitted.
>
>> +</ul>
>>  
>> -<ol>
>> -  <li>Post <q>!join #spectrum</q> in your "Freenode IRC Bridge" chat.</li>
>> -  <li>Accept the invitation you are sent.</li>
>> -</ol>
>>  
>>  <p>
>>  If you experience this issue, kindly report it to the people who run
>> -- 
>> 2.28.0
>
> As I said above, I'm happy to just fix up the patch myself and apply it if
> you'd prefer.
>
> One more thing -- this probably makes you a (minor) copyright holder in
> this file.  Are you happy if I add "SPDX-FileCopyrightText: 2020
> Philipp" to the copyright header at the top of the file?  (You can give
> me a surname if you want, or not -- up to you.)  And would you prefer
> your email address be included in the notice, or not (either is fine)?

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] Add and clarify matrix workarounds.
  2020-08-11 21:54   ` Philipp Steinpaß
@ 2020-08-12 13:34     ` Alyssa Ross
  2020-08-15 13:15       ` [PATCH www v2] " Philipp Steinpaß
  0 siblings, 1 reply; 6+ messages in thread
From: Alyssa Ross @ 2020-08-12 13:34 UTC (permalink / raw)
  To: Philipp Steinpaß; +Cc: devel

Philipp Steinpaß <philipp@xndr.de> writes:

> Thank you for the remarks, they were all very helpfull.
> If you want to include me in the copyright, you are free to use my full
> name. It's in the mail header now.

Cool, so I'll add the following if that's okay:

<!-- SPDX-FileCopyrightText: 2020 Philipp Steinpaß <philipp@xndr.de> -->

> P.S. Please feel free to comment on any potential problems with the
> formatting of these patch mails, if you want to. It's my first time
> using git via mail and I'd like todo it the proper way right away.

Okay!  Well, what you've done here has pretty much worked, but there's a
couple of things that were a little unusual:

- When I apply a patch with git am, it expects to find the commit
  message at the start of the email.  So usually, when you're sending v2
  of a patch, you repeat the message from v1, because that's usually
  what makes sense to be recorded in the commit log.  If you want to
  include stuff like you did here, describing what's changed in this
  version of the patch, you can include that after the "---" (above the
  diffstat), and it won't become part of the commit message.

- Often people indicate which version of a patch they're sending using
  the subject, like "[PATCH v2] Add and clarify Matrix workarounds".

Thanks for your patch!  I appreciate it -- I know it's not easy getting
up to speed with a new workflow.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH www v2] Add and clarify matrix workarounds.
  2020-08-12 13:34     ` Alyssa Ross
@ 2020-08-15 13:15       ` " Philipp Steinpaß
  2020-08-21 18:10         ` Alyssa Ross
  0 siblings, 1 reply; 6+ messages in thread
From: Philipp Steinpaß @ 2020-08-15 13:15 UTC (permalink / raw)
  To: Alyssa Ross; +Cc: devel

Added alternative matrix workarounds and streamlined the existing one.

---
 participating.html | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/participating.html b/participating.html
index 811fcf4..10665ca 100644
--- a/participating.html
+++ b/participating.html
@@ -78,13 +78,18 @@ the web.
 <h3>Note for Matrix users</h3>
 
 <p>
-There appears to be an issue with Matrix's IRC bridge that prevents
-Matrix users from joining #spectrum.  The workaround is as follows:
-
-<ol>
-  <li>Post <q>!join #spectrum</q> in your "Freenode IRC Bridge" chat.</li>
-  <li>Accept the invitation you are sent.</li>
-</ol>
+There appears to be an issue with Matrix's IRC bridged room that prevents
+Matrix users from joining the channel with the normal alias
+#freenode_#spectrum:matrix.org. There are the following workarounds:
+
+<ul>
+  <li>Join the room via it's internal name:
+    <kbd>/join !ZsIiqZmCTSWHpTQWaw:matrix.org</kbd>.
+  <li>Join the room via
+    <a href="https://matrix.to/#/!ZsIiqZmCTSWHpTQWaw:matrix.org">matrix.to link</a>.</li>
+  <li>Ask the bridges appservice to invite you to the room:
+    <kbd>/msg @appservice-irc:matrix.org !join #spectrum</kbd> and accept the invite.
+</ul>
 
 <p>
 If you experience this issue, kindly report it to the people who run
--

Okay, I hope I did everything right this time :-)

Thanks for your tipps

Alyssa Ross writes:

> Philipp Steinpaß <philipp@xndr.de> writes:
>
>> Thank you for the remarks, they were all very helpfull.
>> If you want to include me in the copyright, you are free to use my full
>> name. It's in the mail header now.
>
> Cool, so I'll add the following if that's okay:
>
> <!-- SPDX-FileCopyrightText: 2020 Philipp Steinpaß <philipp@xndr.de> -->
>
>> P.S. Please feel free to comment on any potential problems with the
>> formatting of these patch mails, if you want to. It's my first time
>> using git via mail and I'd like todo it the proper way right away.
>
> Okay!  Well, what you've done here has pretty much worked, but there's a
> couple of things that were a little unusual:
>
> - When I apply a patch with git am, it expects to find the commit
>   message at the start of the email.  So usually, when you're sending v2
>   of a patch, you repeat the message from v1, because that's usually
>   what makes sense to be recorded in the commit log.  If you want to
>   include stuff like you did here, describing what's changed in this
>   version of the patch, you can include that after the "---" (above the
>   diffstat), and it won't become part of the commit message.
>
> - Often people indicate which version of a patch they're sending using
>   the subject, like "[PATCH v2] Add and clarify Matrix workarounds".
>
> Thanks for your patch!  I appreciate it -- I know it's not easy getting
> up to speed with a new workflow.

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH www v2] Add and clarify matrix workarounds.
  2020-08-15 13:15       ` [PATCH www v2] " Philipp Steinpaß
@ 2020-08-21 18:10         ` Alyssa Ross
  0 siblings, 0 replies; 6+ messages in thread
From: Alyssa Ross @ 2020-08-21 18:10 UTC (permalink / raw)
  To: Philipp Steinpaß; +Cc: devel

Philipp Steinpaß <philipp@xndr.de> writes:

> Added alternative matrix workarounds and streamlined the existing one.
>
> ---
>  participating.html | 19 ++++++++++++-------
>  1 file changed, 12 insertions(+), 7 deletions(-)
>

Thanks!  Applied (with added copyright header and extraneous </li>
removed) and pushed as 6c3a773. :)

Sorry for taking a while to get back round to this.  I've been able
to work on Spectrum unusually little this week.

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, back to index

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-08-11 16:32 [PATCH] Add and clarify matrix workarounds Philipp
2020-08-11 18:31 ` Alyssa Ross
2020-08-11 21:54   ` Philipp Steinpaß
2020-08-12 13:34     ` Alyssa Ross
2020-08-15 13:15       ` [PATCH www v2] " Philipp Steinpaß
2020-08-21 18:10         ` Alyssa Ross

patches and low-level development discussion

Archives are clonable:
	git clone --mirror https://spectrum-os.org/lists/archives/spectrum-devel/0 spectrum-devel/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 spectrum-devel spectrum-devel/ https://spectrum-os.org/lists/archives/spectrum-devel \
		public-inbox+spectrum-devel@spectrum-os.org devel@spectrum-os.org
	public-inbox-index spectrum-devel

Example config snippet for mirrors

Newsgroups are available over NNTP:
	nntps://spectrum-os.org/inbox.comp.spectrum.devel
	nntp://spectrum-os.org/inbox.comp.spectrum.devel


AGPL code for this site: https://ftp.qyliss.net/public-inbox/public-inbox-1.2.0-qyliss-81hmc5wifzkbfpmrxydn7mh1xxjk5b48.tar.gz