[Pkg-javascript-devel] Bug#705393: [RFR] templates://sipml5/{sipml5-web-phone.templates}
Christian PERRIER wrote:
Your review should be sent as an answer to this mail.
[...]
Template: sipml5-web-phone/webserver
Type: boolean
Default: true
-_Description: Automatically configure apache2?
+_Description: Automatically configure Apache for Sipml5?
[...] ^^
We also need to specify for what it is to be configured, in case the
question comes in the middle of a bunch of other questions.
Agreed, but the upstream name seems to be SipML5 (or perhaps sipML5).
Meanwhile in the control file:
Multi-Arch: foreign
Depends: ${misc:Depends}
Recommends: javascript-common
-Description: JavaScript implementation of a WebRTC SIP video phone
- HTML5 SIP client entirely written in JavaScript for integration in
- any web site, incude a blog, CMS or web application. Requires
- a modern WebRTC capable web browser and a SIP server/proxy supporting
+Description: WebRTC SIP video phone - Javascript library
Exactly what I was thinking, except it's JavaScript.
+ Simpl5 is an HTML5 SIP client entirely written in JavaScript for
integration in
^^^
If only that acronym worked!
I would also change s/in/into/.
+ any web site, such as a blog, CMS or web application. It requires
Add a comma for d-l-e house style: ^,
+ a WebRTC-capable web browser and a SIP server/proxy supporting
the SIP over WebSockets transport.
[...]
WebRTC-capable : use hyphen.
I'm also tempted to call it the SIP-over-WebSockets transport, but
that's probably overdoing it.
[...]
-Description: Basic SIP video-phone web page based on WebRTC
+Description: WebRTC SIP video-phone - sample web page
To me that isn't really a big enough hint at the fact that it actually
implements a SIP client. How about demonstration web page?
Oh, and I notice only this one hyphenates video-phone. Okay, let's
standardise on that.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru sipml5.pristine/debian/control sipml5/debian/control
--- sipml5.pristine/debian/control 2013-02-23 20:39:43.0 +
+++ sipml5/debian/control 2013-04-22 11:15:09.439629322 +0100
@@ -14,11 +14,11 @@
Multi-Arch: foreign
Depends: ${misc:Depends}
Recommends: javascript-common
-Description: JavaScript implementation of a WebRTC SIP video phone
- HTML5 SIP client entirely written in JavaScript for integration in
- any web site, incude a blog, CMS or web application. Requires
- a modern WebRTC capable web browser and a SIP server/proxy supporting
- the SIP over WebSockets transport.
+Description: WebRTC SIP video-phone - JavaScript library
+ SipML5 is an HTML5 SIP client entirely written in JavaScript for integration
+ into any web site, such as a blog, CMS, or web application. It requires a
+ WebRTC-capable web browser and a SIP server/proxy supporting the SIP over
+ WebSockets transport.
.
This package provides the JavaScript library for use in web sites
or for other packages that require it.
@@ -28,11 +28,11 @@
Multi-Arch: foreign
Depends: ${misc:Depends}
Recommends: libjs-sipml5
-Description: JavaScript implementation of a WebRTC SIP video phone - API docs
- HTML5 SIP client entirely written in JavaScript for integration in
- any web site, incude a blog, CMS or web application. Requires
- a modern WebRTC capable web browser and a SIP server/proxy supporting
- the SIP over WebSockets transport.
+Description: WebRTC SIP video-phone - API documentation
+ SipML5 is an HTML5 SIP client entirely written in JavaScript for integration
+ into any web site, such as a blog, CMS, or web application. It requires a
+ WebRTC-capable web browser and a SIP server/proxy supporting the SIP over
+ WebSockets transport.
.
This package provides the API documentation for the JavaScript library.
@@ -41,11 +41,11 @@
Multi-Arch: foreign
Depends: ${misc:Depends}, libjs-sipml5, libjs-jquery, apache2 | lighttpd | httpd
Recommends: repro, resiprocate-turn-server
-Description: Basic SIP video-phone web page based on WebRTC
- HTML5 SIP client entirely written in JavaScript for integration in
- any web site, incude a blog, CMS or web application. Requires
- a modern WebRTC capable web browser and a SIP server/proxy supporting
- the SIP over WebSockets transport.
+Description: WebRTC SIP video-phone - demonstration web page
+ SipML5 is an HTML5 SIP client entirely written in JavaScript for integration
+ into any web site, such as a blog, CMS, or web application. It requires a
+ WebRTC-capable web browser and a SIP server/proxy supporting the SIP over
+ WebSockets transport.
.
This package provides a basic HTML implementation of a phone that
can be published through a web server such as Apache.
diff -ru sipml5.pristine/debian/sipml5-web-phone.templates sipml5/debian/sipml5-web-phone.templates
--- sipml5.pristine/debian/sipml5-web-phone.templates 2013-04-14 18:33:39.756121203 +0100
+++
[Pkg-javascript-devel] Bug#705393: [RFR] templates://sipml5/{sipml5-web-phone.templates}
Quoting Justin B Rye (justin.byam@gmail.com): Your review should be sent as an answer to this mail. (snip Justin's review) I just picked all changes suggested by Justin (who said but this is always what you're doing anyway! ?). signature.asc Description: Digital signature ___ Pkg-javascript-devel mailing list Pkg-javascript-devel@lists.alioth.debian.org http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-javascript-devel
[Pkg-javascript-devel] Bug#705393: [RFR] templates://sipml5/{sipml5-web-phone.templates}
Please find, for review, the debconf templates and packages descriptions for
the sipml5 source package.
This review will last from Monday, April 22, 2013 to Thursday, May 02, 2013.
Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.
Your review should be sent as an answer to this mail.
When appropriate, I will send intermediate requests for review, with
[RFRn] (n=2) as a subject tag.
When we will reach a consensus, I send a Last Chance For
Comments mail with [LCFC] as a subject tag.
Finally, a summary will be sent to the review bug report,
and a mail will be sent to this list with [BTS] as a subject tag.
Rationale:
--- sipml5.old/debian/sipml5-web-phone.templates2013-04-14
11:27:07.222913359 +0200
+++ sipml5/debian/sipml5-web-phone.templates2013-04-18 07:48:08.294045748
+0200
@@ -1,14 +1,14 @@
Template: sipml5-web-phone/webserver
Type: boolean
Default: true
-_Description: Automatically configure apache2?
+_Description: Automatically configure Apache for Sipml5?
The package will be unavailable until a web server is configured.
- Automatic configuration can be performed for the Apache 2 web server.
+ Automatic configuration can be performed for the Apache web server.
There is imho no need to specifiy this is apache2 we configure.
We also need to specify for what it is to be configured, in case the
question comes in the middle of a bunch of other questions.
Template: sipml5-web-phone/reload
Type: boolean
Default: true
-_Description: Reload apache2 configuration?
+_Description: Reload Apache configuration?
In order to activate the new configuration, the web server needs
to reload its configuration. If you choose not to do this automatically,
you should do so manually at the first opportunity.
Same rationale.
--- sipml5.old/debian/control 2013-04-14 11:27:07.222913359 +0200
+++ sipml5/debian/control 2013-04-18 07:52:08.565973981 +0200
@@ -14,10 +14,10 @@
Multi-Arch: foreign
Depends: ${misc:Depends}
Recommends: javascript-common
-Description: JavaScript implementation of a WebRTC SIP video phone
- HTML5 SIP client entirely written in JavaScript for integration in
- any web site, incude a blog, CMS or web application. Requires
- a modern WebRTC capable web browser and a SIP server/proxy supporting
+Description: WebRTC SIP video phone - Javascript library
+ Simpl5 is an HTML5 SIP client entirely written in JavaScript for integration
in
+ any web site, such as a blog, CMS or web application. It requires
+ a WebRTC-capable web browser and a SIP server/proxy supporting
the SIP over WebSockets transport.
.
This package provides the JavaScript library for use in web sites
Specifying that it is written in Javascript is probably not useful, at
least in the short description. Indeed, I propose to specify it but in
the specific part of the description.
In the long description, use the standard Foo is blahblah
style. And, here, explain that it is entirely written in Javascript.
WebRTC-capable : use hyphen.
Other changes below are just harmonization with this.
@@ -28,10 +28,10 @@
Multi-Arch: foreign
Depends: ${misc:Depends}
Recommends: libjs-sipml5
-Description: JavaScript implementation of a WebRTC SIP video phone - API docs
- HTML5 SIP client entirely written in JavaScript for integration in
- any web site, incude a blog, CMS or web application. Requires
- a modern WebRTC capable web browser and a SIP server/proxy supporting
+Description: WebRTC SIP video phone - API documentation
+ Simpl5 is an HTML5 SIP client entirely written in JavaScript for integration
in
+ any web site, such as a blog, CMS or web application. It requires
+ a WebRTC-capable web browser and a SIP server/proxy supporting
the SIP over WebSockets transport.
.
This package provides the API documentation for the JavaScript library.
@@ -41,10 +41,10 @@
Multi-Arch: foreign
Depends: ${misc:Depends}, libjs-sipml5, libjs-jquery, apache2 | lighttpd |
httpd
Recommends: repro, resiprocate-turn-server
-Description: Basic SIP video-phone web page based on WebRTC
- HTML5 SIP client entirely written in JavaScript for integration in
- any web site, incude a blog, CMS or web application. Requires
- a modern WebRTC capable web browser and a SIP server/proxy supporting
+Description: WebRTC SIP video-phone - sample web page
+ Simpl5 is an HTML5 SIP client entirely written in JavaScript for integration
in
+ any web site, such as a blog, CMS or web application. It requires
+ a WebRTC-capable web browser and a SIP server/proxy supporting
the SIP over WebSockets transport.
.
This package provides a basic HTML implementation of a phone that
--
Template: sipml5-web-phone/webserver
Type: boolean
Default: true
_Description: Automatically configure Apache for Sipml5?
The package will be unavailable until a web server is configured.
Automatic configuration can be performed for the Apache web server.
