<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; line-break: after-white-space;" class="">Taking into account Steve and Greg feedback, perhaps we need to define the criteria for what should be in there?<div class=""><br class=""></div><div class="">I think we need to focus on what is useful to the user. In particular things that we’ve done that may impact his usage experience.</div><div class=""><br class=""></div><div class="">I suggest a short one or two line summary headline. Then, individual points to cover:</div><div class=""><br class=""></div><div class=""><ol class="MailOutline"><li class="">User visible changes</li><li class="">Changes to functionality that could impact users</li><li class="">Enhancements and new features that would be of benefit to users</li><li class="">Github reported issues addressed</li></ol></div><div class=""><br class=""></div><div class="">I am not sure about #4. Should we be reporting ALL github issues, or just those that meet the first three criteria?</div><div class=""><br class=""></div><div class="">Looking at the example, and what @Michael suggests removing, I think that would keep:</div><div class=""><ul class="MailOutline"><li class="">Wifi scan responsiveness</li><li class="">The “Server v2: 50 ms delay …” should probably be a github reported issue.</li><li class="">Watchdogs (included because it could impact users if they suddenly start to see random reboots, but I agree that this is borderline for inclusion)</li></ul></div><div class=""><br class=""></div><div class="">I don’t think the SD CARD issue meets the above inclusion criteria. But, somebody who had been having issues with his SD CARD would probably be interested in knowing we have made changes to try to make it better.</div><div class=""><br class=""></div><div class="">Does that work?</div><div class=""><br class=""></div><div class="">Regards, Mark.<br class=""><div><br class=""><blockquote type="cite" class=""><div class="">On 12 Apr 2018, at 12:13 AM, Michael Balzer <<a href="mailto:dexter@expeedo.de" class="">dexter@expeedo.de</a>> wrote:</div><br class="Apple-interchange-newline"><div class="">
  
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" class="">
  
  <div text="#000000" bgcolor="#FFFFFF" class="">
    Mark,<br class="">
    <br class="">
    I would reduce this much further to:<br class="">
    <br class="">
    <tt class="">????-??-?? ???  ???????  OTA release</tt><tt class=""><br class="">
    </tt><tt class="">- Tesla Model S: Support v.bat.soc, v.pos.speed and
      park/drive status metrics</tt><br class="">
    <br class="">
    This is IMO the only change from the current log a normal user needs
    to know about.<br class="">
    <br class="">
    <br class="">
    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 class="">
    <br class="">
    <tt class="">- SD CARD: Provide configurable sdcard parameters:</tt><tt class=""><br class="">
    </tt><tt class="">    sdcard [maxfreq.khz] = 16000         Maximum frequency
      (in kHz) of SD CARD bus</tt><tt class=""><br class="">
    </tt><tt class="">    sdcard [automount] = yes             Automatically
      mount SD CARD on insertion</tt><tt class=""><br class="">
    </tt><br class="">
    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 class=""><br class="">
      <br class="">
      - Boot: store & send crash debug info (*-OVM-DebugCrash
      records)</tt><tt class=""><br class="">
    </tt><br class="">
    The remaining changes are bug fixes or internal stuff no user needs
    to know, only developers:<br class="">
    <br class="">
    <tt class=""><tt class="">- Wifi: Increase scan responsiveness (60 seconds -> 10,
        on first scan)</tt><tt class=""><br class="">
      </tt>- Server v2: Introduce a 50ms delay between setting charge
      mode and current in same command</tt><tt class=""><br class="">
    </tt><tt class="">- Core: Changes to housekeeping and events tasks to move
      event delivery and housekeeping actions</tt><tt class=""><br class="">
    </tt><tt class="">  to the event task (removing housekeeping task)</tt><tt class=""><br class="">
    </tt><tt class="">- Core: Enable watchdogs for production builds</tt><tt class=""><br class="">
    </tt><tt class="">- SD CARD: Reliability improvements to SD CARD
      auto-mounting on insertion</tt><tt class=""><br class="">
    </tt><tt class="">- Core: Introduce protection for thread safety while
      logging, to workaround ESP IDF bug</tt><tt class=""><br class="">
    </tt><tt class="">  <a class="moz-txt-link-freetext" href="https://github.com/espressif/esp-idf/issues/1837">https://github.com/espressif/esp-idf/issues/1837</a></tt><tt class=""><br class="">
    </tt><br class="">
    All this can be reduced to a single line "lots of bug fixes and
    optimizations".<br class="">
    <br class="">
    Am I too radical on this?<br class="">
    <br class="">
    Regards,<br class="">
    Michael<br class="">
    <br class="">
    <br class="">
    <div class="moz-cite-prefix">Am 11.04.2018 um 02:06 schrieb Mark
      Webb-Johnson:<br class="">
    </div>
    <blockquote type="cite" cite="mid:3A7C12FE-A613-4AD0-BF7C-B3B2F27C9954@webb-johnson.net" class="">
      <meta http-equiv="Content-Type" content="text/html; charset=utf-8" class="">
      <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=""><font class="" face="Andale Mono"><span style="font-size: 14px;" class="">6f732b2 Improve
                hexdump of 're list' to show ascii printable characters.</span></font></div>
          <div class=""><font class="" face="Andale Mono"><span style="font-size: 14px;" class="">82cccc7 Tesla Model S:
                Gear selector - on/awake</span></font></div>
          <div class=""><font class="" face="Andale Mono"><span style="font-size: 14px;" class="">3e0d5b1 TeslaModelS:
                v.bat.soc and v.pos.speed metrics</span></font></div>
          <div class=""><font class="" face="Andale Mono"><span style="font-size: 14px;" class="">e898c1b TeslaModelS:
                Fix for metric v.bat.soc</span></font></div>
          <div class=""><font class="" face="Andale Mono"><span style="font-size: 14px;" class="">c5bc34a TeslaModelS:
                Fix for metric v.pos.speed</span></font></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="">37c5f4b Boot: store
                & send crash debug info (*-OVM-DebugCrash records)
                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=""><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></div>
          <div class=""><font class="" face="Andale Mono"><span style="font-size: 14px;" class="">21e4110 Increase wifi
                scan responsiveness</span></font></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 class=""><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">http://lists.openvehicles.com/mailman/listinfo/ovmsdev</a><br class="">
                  </div>
                </div>
              </blockquote>
            </div>
            <br class="">
          </div>
        </div>
      </div>
      <br class="">
      <fieldset class="mimeAttachmentHeader"></fieldset>
      <br class="">
      <pre wrap="" class="">_______________________________________________
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 class="">
    <pre class="moz-signature" cols="160">-- 
Michael Balzer * Helkenberger Weg 9 * D-58256 Ennepetal
Fon 02333 / 833 5735 * Handy 0176 / 206 989 26
</pre>
  </div>

_______________________________________________<br class="">OvmsDev mailing list<br class=""><a href="mailto:OvmsDev@lists.openvehicles.com" class="">OvmsDev@lists.openvehicles.com</a><br class="">http://lists.openvehicles.com/mailman/listinfo/ovmsdev<br class=""></div></blockquote></div><br class=""></div></body></html>