Browse Source

Merge pull request #9768 from electron/update-breaking-changes

mention ARM and FIXME in breaking changes doc
Kevin Sawicki 7 years ago
parent
commit
493cfd38d6
1 changed files with 24 additions and 0 deletions
  1. 24 0
      docs/tutorial/planned-breaking-changes.md

+ 24 - 0
docs/tutorial/planned-breaking-changes.md

@@ -198,3 +198,27 @@ command line flag when building native Node modules.
 Deprecated: https://atom.io/download/atom-shell
 
 Replace with: https://atom.io/download/electron
+
+## Duplicate ARM Assets
+
+Each Electron release includes two identical ARM builds with slightly different 
+filenames, like `electron-v1.7.3-linux-arm.zip` and 
+`electron-v1.7.3-linux-armv7l.zip`. The asset with the `v7l` prefix was added 
+to clarify to users which ARM version it supports, and to disambiguate it from 
+future armv6l and arm64 assets that may be produced.
+
+The file _without the prefix_ is still being published to avoid breaking any 
+setups that may be consuming it. Starting at 2.0, the un-prefixed file will 
+no longer be published.
+
+For details, see
+[6986](https://github.com/electron/electron/pull/6986)
+and 
+[7189](https://github.com/electron/electron/pull/7189).
+
+
+## `FIXME` comments
+
+The `FIXME` string is used in code comments to denote things that should be 
+fixed for the 2.0 release. See 
+https://github.com/electron/electron/search?q=fixme