Uploaded image for project: 'Qpid'
  1. Qpid
  2. QPID-3067

Example structure is misleading (c++ examples)

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 0.8
    • Fix Version/s: 0.9
    • Component/s: C++ Client, Qpid Examples
    • Labels:
      None

      Description

      The structure of the examples directory (as installed) is the following:

      direct
      failover
      fanout
      messaging
      pub-sub
      qmf-console
      request-response
      tradedemo
      verify
      verify_all
      xml-exchange

      This structure hides the fact that there are two APIs, an old one and a new, recommended API. The uninitiated are not going to figure out that they should be looking in the "messaging" directory for the most relevant examples.

      I'd like to suggest that we rearrange these directories such that all old-API examples are under a single subdirectory called "old-api" or similar.

        Issue Links

          Activity

          Hide
          shuston Steve Huston added a comment -

          That is a confusing aspect of the layout, I agree. Barring an effort to dissuade users from using old-api, I agree with this approach. If there's an effort to dissuade users, another option is to just remove the old-api examples.

          Show
          shuston Steve Huston added a comment - That is a confusing aspect of the layout, I agree. Barring an effort to dissuade users from using old-api, I agree with this approach. If there's an effort to dissuade users, another option is to just remove the old-api examples.
          Hide
          chug Chuck Rolke added a comment -

          Move them to old-api and don't delete them.

          Although you are discouraging its use, the old api it is still used significantly by WCF.

          You can dissuade new users by moving the offending examples to an old-api directory. Also, rename the old-api projects in CMake with an "old-api-" prefix. That way, under a visual studio solution, the examples would be grouped together in Solution Explorer and the user is alerted that they use an old api. If ever you change the client library interface then the old-api examples may prove useful still by exposing the changes.

          Show
          chug Chuck Rolke added a comment - Move them to old-api and don't delete them. Although you are discouraging its use, the old api it is still used significantly by WCF. You can dissuade new users by moving the offending examples to an old-api directory. Also, rename the old-api projects in CMake with an "old-api-" prefix. That way, under a visual studio solution, the examples would be grouped together in Solution Explorer and the user is alerted that they use an old api. If ever you change the client library interface then the old-api examples may prove useful still by exposing the changes.
          Hide
          cctrieloff Carl Trieloff added a comment -


          When you do this, can you also bring william's example in jiri 2784

          Show
          cctrieloff Carl Trieloff added a comment - When you do this, can you also bring william's example in jiri 2784

            People

            • Assignee:
              gsim Gordon Sim
              Reporter:
              tedross Ted Ross
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development