You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@qpid.apache.org by "William Henry (JIRA)" <qp...@incubator.apache.org> on 2008/05/12 18:21:03 UTC
[jira] Created: (QPID-1051) The C++ examples contain some typos and
other mistakes that will confuse users. These are usability errors
The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
----------------------------------------------------------------------------------------------------------
Key: QPID-1051
URL: https://issues.apache.org/jira/browse/QPID-1051
Project: Qpid
Issue Type: Bug
Components: C++ Client
Environment: n/a but Fedora 8 on a Thinkpad T61
Reporter: William Henry
Priority: Minor
There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
E.g.
Several files declare unused Message instances:
Message message;
Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
I will attach some diff files that show the bugs in the code.
request_response/server.cpp - declares a Message instance called message but doesn't use it.
pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Assigned: (QPID-1051) The C++ examples contain some typos
and other mistakes that will confuse users. These are usability errors
Posted by "Alan Conway (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Alan Conway reassigned QPID-1051:
---------------------------------
Assignee: Alan Conway
> The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Assignee: Alan Conway
> Priority: Minor
> Attachments: diff_direct_declare_queues, diff_direct_listener, diff_fanout_listener, diff_fanout_producer, diff_pubsub_topic_listener, diff_pubsub_topic_publisher, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (QPID-1051) The C++ examples contain some typos
and other mistakes that will confuse users. These are usability errors
Posted by "William Henry (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12633866#action_12633866 ]
William Henry commented on QPID-1051:
-------------------------------------
Okay I was green when I opened this. I'll update the diffs with one svn diff file ... :-)
William
> The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Assignee: Alan Conway
> Priority: Minor
> Fix For: M4
>
> Attachments: diff_direct_declare_queues, diff_direct_listener, diff_fanout_listener, diff_fanout_producer, diff_pubsub_topic_listener, diff_pubsub_topic_publisher, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (QPID-1051) The C++ examples contain some typos and
other mistakes that will confuse users. These are usability errors
Posted by "Gordon Sim (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Gordon Sim updated QPID-1051:
-----------------------------
Affects Version/s: M4
M3
> The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Affects Versions: M3, M4
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Assignee: Alan Conway
> Priority: Minor
> Fix For: M4
>
> Attachments: diff_direct_declare_queues, diff_direct_listener, diff_fanout_listener, diff_fanout_producer, diff_pubsub_topic_listener, diff_pubsub_topic_publisher, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (QPID-1051) The C++ examples contain some typos
and other mistakes that will confuse users. These are usability errors
Posted by "William Henry (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12634147#action_12634147 ]
William Henry commented on QPID-1051:
-------------------------------------
I think there is a difference between violating the basic design of the examples and having declarations for objects that aren't used and potentially confusing.
If need be perhaps we could leave them in there but comment them out when not used with a comment:
// Not used in this example.
Otherwise the new Qpid developer could get confused. And a tutorial that confuses is not meeting its objectives.
> The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Assignee: Alan Conway
> Priority: Minor
> Fix For: M4
>
> Attachments: diff_direct_declare_queues, diff_direct_listener, diff_fanout_listener, diff_fanout_producer, diff_pubsub_topic_listener, diff_pubsub_topic_publisher, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (QPID-1051) The C++ examples contain some typos and
other mistakes that will confuse users. These are usability errors
Posted by "William Henry (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
William Henry updated QPID-1051:
--------------------------------
Attachment: diff_pubsub_topic_publisher
> The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Priority: Minor
> Attachments: diff_direct_declare_queues, diff_direct_listener, diff_fanout_listener, diff_fanout_producer, diff_pubsub_topic_listener, diff_pubsub_topic_publisher, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (QPID-1051) The C++ examples contain some typos and
other mistakes that will confuse users. These are usability errors
Posted by "William Henry (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
William Henry updated QPID-1051:
--------------------------------
Attachment: diff_pubsub_topic_listener
diff_fanout_producer
diff_fanout_listener
more diff files
> The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Priority: Minor
> Attachments: diff_direct_declare_queues, diff_direct_listener, diff_fanout_listener, diff_fanout_producer, diff_pubsub_topic_listener, diff_pubsub_topic_publisher, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (QPID-1051) The C++ examples contain some typos
and other mistakes that will confuse users. These are usability errors
Posted by "Gordon Sim (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12634177#action_12634177 ]
Gordon Sim commented on QPID-1051:
----------------------------------
I agree. Having unused variables is at worst confusing and at best a bit sloppy. Perhaps 'Message message;' shouldn't be in the template at all? Also having unneeded includes is in my view less helpful. The template can show the bare minimum needed and as new includes are required, they can be explicitly highlighted, allowing the user to become familiar with what is defined where. (Thats my 2cents, at least!)
> The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Assignee: Alan Conway
> Priority: Minor
> Fix For: M4
>
> Attachments: diff_direct_declare_queues, diff_direct_listener, diff_fanout_listener, diff_fanout_producer, diff_pubsub_topic_listener, diff_pubsub_topic_publisher, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (QPID-1051) The C++ examples contain some typos and
other mistakes that will confuse users. These are usability errors
Posted by "William Henry (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
William Henry updated QPID-1051:
--------------------------------
Attachment: diff_req-resp_server
diff_direct_listener
diff_direct_declare_queues
Diff files
> The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Priority: Minor
> Attachments: diff_direct_declare_queues, diff_direct_listener, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (QPID-1051) The C++ examples contain some typos
and other mistakes that will confuse users. These are usability errors
Posted by "Jonathan Robie (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12634143#action_12634143 ]
Jonathan Robie commented on QPID-1051:
--------------------------------------
Some of the comments definitely do need cleaning up.
Some of the changes you make violate the basic design of the examples, though. The tutorial says explicitly that we use the same template for all examples - the contributed version of the tutorial is not yet up on the Qpid site, here's the equivalent page from the Red Hat site:
http://www.redhat.com/docs/en-US/Red_Hat_Enterprise_MRG/1.0/html/Messaging_Tutorial/sect-Messaging_Tutorial-Using_RHM_with_C-Creating_and_Closing_Sessions.html
I think any changes to the examples need to make sure they use that template, even if not all parts of the template are needed by all programs.
Jonathan
> The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Assignee: Alan Conway
> Priority: Minor
> Fix For: M4
>
> Attachments: diff_direct_declare_queues, diff_direct_listener, diff_fanout_listener, diff_fanout_producer, diff_pubsub_topic_listener, diff_pubsub_topic_publisher, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (QPID-1051) The C++ examples contain some typos
and other mistakes that will confuse users. These are usability errors
Posted by "Jonathan Robie (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12660761#action_12660761 ]
Jonathan Robie commented on QPID-1051:
--------------------------------------
I believe all issues are now addressed in the current examples.
> The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Affects Versions: M3, M4
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Assignee: Alan Conway
> Priority: Minor
> Fix For: M4
>
> Attachments: diff_direct_declare_queues, diff_direct_listener, diff_fanout_listener, diff_fanout_producer, diff_pubsub_topic_listener, diff_pubsub_topic_publisher, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Resolved: (QPID-1051) The C++ examples contain some typos
and other mistakes that will confuse users. These are usability errors
Posted by "Gordon Sim (JIRA)" <qp...@incubator.apache.org>.
[ https://issues.apache.org/jira/browse/QPID-1051?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Gordon Sim resolved QPID-1051.
------------------------------
Resolution: Fixed
Believed fixed.
> The C++ examples contain some typos and other mistakes that will confuse users. These are usability errors
> ----------------------------------------------------------------------------------------------------------
>
> Key: QPID-1051
> URL: https://issues.apache.org/jira/browse/QPID-1051
> Project: Qpid
> Issue Type: Bug
> Components: C++ Client
> Affects Versions: M3, M4
> Environment: n/a but Fedora 8 on a Thinkpad T61
> Reporter: William Henry
> Assignee: Alan Conway
> Priority: Minor
> Fix For: M4
>
> Attachments: diff_direct_declare_queues, diff_direct_listener, diff_fanout_listener, diff_fanout_producer, diff_pubsub_topic_listener, diff_pubsub_topic_publisher, diff_req-resp_server
>
>
> There are a few residual usability errors that seem to be the result of copying examples over and not cleaning up. None of these bugs stop the code from compiling or running but would cause usability problems for new users that are looking at the examples as templates on how to use qpid.
> E.g.
> Several files declare unused Message instances:
> Message message;
> Some files headers contain erroneous information. Either mentioning non-existent files or using incorrect names.
> I will attach some diff files that show the bugs in the code.
> request_response/server.cpp - declares a Message instance called message but doesn't use it.
> pub-sub/topic_listener.cpp = mentions topic_config_queues.cpp in the header but there is no such file.
> pub-sub/topic_publisher.cpp = mentions topic_config_queues.cpp in the header but there is no such file. Message is declared and unused.
> fanout/listener.cpp - minor typo 'fro' for 'from' in header and Message declared and unused
> fanout/producer.cpp - declare_queues.cpp mentioned in header and Message declared twice. One in try block is used.
> direct/declare_queues.cpp - named incorrectly as define_config_queues.cpp in header. Message declared and unused
> direct/lisener.cpp- minor typo 'fro' for 'from' in header . Message declared and unused
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.