<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  </head>
  <body text="#000000" bgcolor="#FFFFFF">
    Hi Michael,<br>
    <br>
    I agree, almost.<br>
    <br>
    We do need to explicitly include any bugs fixed that have been
    reported by a customer, even if the fix is buried in some internal
    stuff.  Also, any changes that are visible to customers, regardless
    of whether it's a bug fix or enhancement, or whether it would be
    something they would directly use or not.  <br>
    <br>
    My reasoning behind this is that we do have a fairly sophisticated
    customer base, and they should be able to directly correlate any
    changes they have reported (bug fix or enhancement request) with the
    release that implemented them.  This builds trust and a sense of
    community between the customers and the development team.  I'd also
    suggest we include the bug number (we have bug numbers, right?) on
    the summary line.  Bug numbers are probably more useful than GIT
    Commits, and the commits might be excluded if they are included in
    the bug report.  There does need to be full traceability for
    changes.<br>
    <br>
    So, the lines bold-ed below, I believe, should be included in this
    demonstration case.<br>
    <br>
    Greg.<br>
    <br>
    <br>
    <div class="moz-cite-prefix">Michael Balzer wrote:<br>
    </div>
    <blockquote type="cite"
      cite="mid:5777c152-653e-5af7-ba9f-98ed48f2c3ac@expeedo.de">
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
      Mark,<br>
      <br>
      I would reduce this much further to:<br>
      <br>
      <tt>????-??-?? ???  ???????  OTA release</tt><tt><br>
      </tt><tt>- Tesla Model S: Support v.bat.soc, v.pos.speed and
        park/drive status metrics</tt><br>
      <br>
      This is IMO the only change from the current log a normal user
      needs to know about.<br>
      <br>
      <br>
      The SD card configuration is on the edge, I would remove that
      entry from the user info as well, as a normal user will (should)
      not need to touch these configs:<br>
      <br>
      <b><tt>- SD CARD: Provide configurable sdcard parameters:</tt></b><b><tt><br>
        </tt></b><b><tt>    sdcard [maxfreq.khz] = 16000         Maximum
          frequency (in kHz) of SD CARD bus</tt></b><b><tt><br>
        </tt></b><b><tt>    sdcard [automount] = yes            
          Automatically mount SD CARD on insertion</tt></b><tt><br>
      </tt><br>
      The DebugCrash records info is also on the edge, I would now also
      remove that from the changes file as no normal user can make use
      of that info:<tt><br>
        <br>
        <b>- Boot: store & send crash debug info (*-OVM-DebugCrash
          records)</b></tt><tt><br>
      </tt><br>
      The remaining changes are bug fixes or internal stuff no user
      needs to know, only developers:<br>
      <br>
      <b><tt><tt>- Wifi: Increase scan responsiveness (60 seconds ->
            10, on first scan)</tt><tt><br>
          </tt>- Server v2: Introduce a 50ms delay between setting
          charge mode and current in same command</tt></b><tt><br>
      </tt><tt>- Core: Changes to housekeeping and events tasks to move
        event delivery and housekeeping actions</tt><tt><br>
      </tt><tt>  to the event task (removing housekeeping task)</tt><tt><br>
      </tt><tt>- Core: Enable watchdogs for production builds</tt><tt><br>
      </tt><b><tt>- SD CARD: Reliability improvements to SD CARD
          auto-mounting on insertion</tt></b><tt><br>
      </tt><tt>- Core: Introduce protection for thread safety while
        logging, to workaround ESP IDF bug</tt><tt><br>
      </tt><tt>  <a class="moz-txt-link-freetext"
          href="https://github.com/espressif/esp-idf/issues/1837"
          moz-do-not-send="true">https://github.com/espressif/esp-idf/issues/1837</a></tt><tt><br>
      </tt><br>
      All this can be reduced to a single line "lots of bug fixes and
      optimizations".<br>
      <br>
      Am I too radical on this?<br>
      <br>
      Regards,<br>
      Michael<br>
      <br>
      <br>
      <div class="moz-cite-prefix">Am 11.04.2018 um 02:06 schrieb Mark
        Webb-Johnson:<br>
      </div>
      <blockquote type="cite"
        cite="mid:3A7C12FE-A613-4AD0-BF7C-B3B2F27C9954@webb-johnson.net">
        <meta http-equiv="Content-Type" content="text/html;
          charset=UTF-8">
        <div class=""><br class="">
        </div>
        Yes, that is the intention. For v2, I generally did this for
        each firmware release by doing a ‘git lola’ (like your 'git log
        --oneline --no-merges’), going through the changelog, and
        updating the changes.txt with non technical translations of core
        functionality changes. Trivial changes were not recorded in
        changes.txt.
        <div class=""><br class="">
        </div>
        <div class="">I just reviewed the latest, and this is what I
          came up with:</div>
        <div class=""><br class="">
        </div>
        <blockquote style="margin: 0 0 0 40px; border: none; padding:
          0px;" class="">
          <div class="">
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">$ git log --oneline
                  --no-merges 3.1.003 master</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">aeb7728 (HEAD ->
                  master) Tesla Model S: Refinements for v.e.handbrake
                  and Mph/Kph support</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">52e8214
                  (origin/master, origin/HEAD) Web shell: touch keyboard
                  optimization</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">2eab5d3 Provide
                  configurable parameters for sdcard: sdcard
                  [maxfreq.khz] = 16000 sdcard [automount] = yes</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">a2804b8 Add
                  ovms_utils.h for FormatHexDump.</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">343ad45 Reimplement
                  setting console prompt for secure mode</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">09f6f6b Tesla Model
                  S: Use 32bit arithmetic for data decoding</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">ed4d700 Tesla Model
                  S: Use 32bit arithmetic for data decoding</span></font></div>
            <div class=""><b><font class="" face="Andale Mono"><span
                    style="font-size: 14px;" class="">6f732b2 Improve
                    hexdump of 're list' to show ascii printable
                    characters.</span></font></b></div>
            <div class=""><b><font class="" face="Andale Mono"><span
                    style="font-size: 14px;" class="">82cccc7 Tesla
                    Model S: Gear selector - on/awake</span></font></b></div>
            <b> </b>
            <div class=""><b><font class="" face="Andale Mono"><span
                    style="font-size: 14px;" class="">3e0d5b1
                    TeslaModelS: v.bat.soc and v.pos.speed metrics</span></font></b></div>
            <b> </b>
            <div class=""><b><font class="" face="Andale Mono"><span
                    style="font-size: 14px;" class="">e898c1b
                    TeslaModelS: Fix for metric v.bat.soc</span></font></b></div>
            <b> </b>
            <div class=""><b><font class="" face="Andale Mono"><span
                    style="font-size: 14px;" class="">c5bc34a
                    TeslaModelS: Fix for metric v.pos.speed</span></font></b></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">ad46fb2 Clone data
                  passed to SignalEvent</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">ed32467 Default
                  production config support for ESP IDF panic stub</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">b38b0ef Mutex
                  protect fsync function call, on logging, to workaround
                  ESP IDF bug <a
                    href="https://github.com/espressif/esp-idf/issues/1837"
                    class="" moz-do-not-send="true">https://github.com/espressif/esp-idf/issues/1837</a></span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class=""><b>37c5f4b Boot:
                    store & send crash debug info (*-OVM-DebugCrash
                    records) </b>Note: needs esp-idf update
                  (daef4b5c11a646b7149bf3534e338f3070ae3abf)</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">1bcbef9 Clone data
                  passed to SignalEvent</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">d9931cb Changelog
                  update</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">be39917 Run SD CARD
                  automount in Events task context, not Timer.</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">f0969a3 Refactor
                  housekeeping/events tasks to use Events task for
                  signal dispatch and housekeeping.</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">97775cf OVMS task
                  naming cleanup</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">90c00b8 Enable
                  watchdog reset for production builds</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">fde6d8d OVMS task
                  naming cleanup</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">f6a8de5 changes.txt
                  update</span></font></div>
            <div class=""><b><font class="" face="Andale Mono"><span
                    style="font-size: 14px;" class="">7ea18b4 Server v2:
                    Delay 50ms on cmd #16 (between setting mode and
                    current)</span></font></b></div>
            <b> </b>
            <div class=""><b><font class="" face="Andale Mono"><span
                    style="font-size: 14px;" class="">21e4110 Increase
                    wifi scan responsiveness</span></font></b></div>
          </div>
        </blockquote>
        <div class=""><br class="">
        </div>
        <div class="">Becomes:</div>
        <div class=""><br class="">
        </div>
        <blockquote style="margin: 0 0 0 40px; border: none; padding:
          0px;" class="">
          <div class="">
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">????-??-?? ???
                   ???????  OTA release</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                       - Wifi: Increase scan responsiveness (60 seconds
                  -> 10, on first scan)</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                       - Server v2: Introduce a 50ms delay between
                  setting charge mode and current in same command</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                       - Core: Changes to housekeeping and events tasks
                  to move event delivery and housekeeping actions</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                         to the event task (removing housekeeping task)</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                       - Core: Enable watchdogs for production builds</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                       - SD CARD: Reliability improvements to SD CARD
                  auto-mounting on insertion</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                       - SD CARD: Provide configurable sdcard
                  parameters:</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                           sdcard [maxfreq.khz] = 16000         Maximum
                  frequency (in kHz) of SD CARD bus</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                           sdcard [automount] = yes            
                  Automatically mount SD CARD on insertion</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                       - Boot: store & send crash debug info
                  (*-OVM-DebugCrash records)</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                       - Core: Introduce protection for thread safety
                  while logging, to workaround ESP IDF bug</span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                         <a
                    href="https://github.com/espressif/esp-idf/issues/1837"
                    class="" moz-do-not-send="true">https://github.com/espressif/esp-idf/issues/1837</a></span></font></div>
            <div class=""><font class="" face="Andale Mono"><span
                  style="font-size: 14px;" class="">                   
                       - Tesla Model S: Support v.bat.soc, v.pos.speed
                  and park/drive status metrics</span></font></div>
          </div>
        </blockquote>
        <div class=""><br class="">
        </div>
        <div class="">This process is helped if people can include full
          information in their commit messages - in particular for
          changes that impact features, usage, provide new options, etc
          - anything that is going to affect or be visible to the user.</div>
        <div class=""><br class="">
        </div>
        <div class="">Currently, the firmware download server has a file
          (<a
href="http://api.openvehicles.com/firmware/ota/%5Bv3.0%7Cv3.1%5D/%3Ctag%3E/ovms3.ver"
            class="" moz-do-not-send="true">http://api.openvehicles.com/firmware/ota/[v3.0|v3.1]/<tag>/ovms3.ver</a>)
          that stores a one-line ‘current version’. I plan to change
          that to include the last few releases for changes.txt (as well
          as the version). That way, ‘ota status’ can show the changes
          in the latest version as well as the version number itself).</div>
        <div class=""><br class="">
        </div>
        <div class="">Regards, Mark.</div>
        <div class="">
          <div class="">
            <div class="">
              <div><br class="">
                <blockquote type="cite" class="">
                  <div class="">On 11 Apr 2018, at 5:31 AM, Michael
                    Balzer <<a href="mailto:dexter@expeedo.de"
                      class="" moz-do-not-send="true">dexter@expeedo.de</a>>
                    wrote:</div>
                  <br class="Apple-interchange-newline">
                  <div class="">
                    <div class="">A suggestion for the changes.txt:<br
                        class="">
                      <br class="">
                      I thought and now suggest this file is intended as
                      an extract of high level changes, i.e. changes
                      that extend or change the user interface and/or
                      features of<br class="">
                      the system, but not bug fixes or internal reworks.<br
                        class="">
                      <br class="">
                      A log of all changes can be created automatically
                      from the git log, no need to do that manually.<br
                        class="">
                      <br class="">
                      git log --oneline --no-merges 3.1.000..<br
                        class="">
                      <br class="">
                      If we add all commits, users will stop reading
                      this file. If we reduce it to high level entries,
                      it becomes a valuable info for users.<br class="">
                      <br class="">
                      Regards,<br class="">
                      Michael<br class="">
                      <br class="">
                      -- <br class="">
                      Michael Balzer * Helkenberger Weg 9 * D-58256
                      Ennepetal<br class="">
                      Fon 02333 / 833 5735 * Handy 0176 / 206 989 26<br
                        class="">
                      <br class="">
                      <br class="">
                      _______________________________________________<br
                        class="">
                      OvmsDev mailing list<br class="">
                      <a href="mailto:OvmsDev@lists.openvehicles.com"
                        class="" moz-do-not-send="true">OvmsDev@lists.openvehicles.com</a><br
                        class="">
                      <a class="moz-txt-link-freetext"
                        href="http://lists.openvehicles.com/mailman/listinfo/ovmsdev"
                        moz-do-not-send="true">http://lists.openvehicles.com/mailman/listinfo/ovmsdev</a><br
                        class="">
                    </div>
                  </div>
                </blockquote>
              </div>
              <br class="">
            </div>
          </div>
        </div>
        <br>
        <fieldset class="mimeAttachmentHeader"></fieldset>
        <br>
        <pre wrap="">_______________________________________________
OvmsDev mailing list
<a class="moz-txt-link-abbreviated" href="mailto:OvmsDev@lists.openvehicles.com" moz-do-not-send="true">OvmsDev@lists.openvehicles.com</a>
<a class="moz-txt-link-freetext" href="http://lists.openvehicles.com/mailman/listinfo/ovmsdev" moz-do-not-send="true">http://lists.openvehicles.com/mailman/listinfo/ovmsdev</a>
</pre>
      </blockquote>
      <br>
      <pre class="moz-signature" cols="160">-- 
Michael Balzer * Helkenberger Weg 9 * D-58256 Ennepetal
Fon 02333 / 833 5735 * Handy 0176 / 206 989 26
</pre>
      <br>
      <fieldset class="mimeAttachmentHeader"></fieldset>
      <br>
      <pre wrap="">_______________________________________________
OvmsDev mailing list
<a class="moz-txt-link-abbreviated" href="mailto:OvmsDev@lists.openvehicles.com">OvmsDev@lists.openvehicles.com</a>
<a class="moz-txt-link-freetext" href="http://lists.openvehicles.com/mailman/listinfo/ovmsdev">http://lists.openvehicles.com/mailman/listinfo/ovmsdev</a>
</pre>
    </blockquote>
    <br>
  </body>
</html>